Criar assinatura

POST 
/v1/subscriptions

Cria uma nova assinatura.

Request

Header Parameters

Idempotency-Key string
Chave única de idempotência para evitar duplicação de requisições.
Example: 5f92f01728e009f403d8502e
base39-external-client-id string

Chave de identificação do cliente externo. Utilizada para identificar o cliente que está realizando a requisição.

application/json

Body

name stringrequired
Nome da assinatura.
Example: Loan created webhook

events

object[]

required

Lista de eventos.

Array [

eventType string

Nome do evento a ser utilizado na subscrição.

Example: loan.created

filters object

Filtros para o evento. Informar o nome do que deseja filtrar e um array com os possíveis valores.

Example: {"status":["canceled","open"]}

]

notification

object

required

url string

Url que será utilizada para o envio do evento.

Example: https://api.example.com/webhooks

headers object

Objeto que define os headers a ser utilizado na chamada HTTP para a url definida.

Example: {"Authorization":"key-12345"}

Responses

201

Retorna o objeto Subscription se a criação for bem-sucedida; caso contrário, retorna um erro.

application/json

Schema

Schema

id string
Identificador exclusivo para o objeto.
Example: subs_5f92f01728e009f403d8502e
name string
Nome da assinatura.
Example: Loan created webhook

events

object[]

Lista de eventos.

Array [

eventType string

Nome do evento a ser utilizado na subscrição.

Example: loan.created

filters object

Filtros para o evento. Informar o nome do que deseja filtrar e um array com os possíveis valores.

Example: {"status":["canceled","open"]}

]

notification

object

url string

Url que será utilizada para o envio do evento.

Example: https://api.example.com/webhooks

headers object

Objeto que define os headers a ser utilizado na chamada HTTP para a url definida.

Example: {"Authorization":"key-12345"}

createdBy

object

clientId string

Identificador do cliente que criou a assinatura.

Example: client_identifier

externalClientId string

Chave de identificação do cliente externo. Utilizada para identificar o cliente que está realizando a requisição. Populado pelo campo enviado no header base39-external-client-id.

app string

Nome da aplicação que criou a assinatura.

Example: backoffice

updatedBy

object

clientId string

Identificador do cliente que criou a assinatura.

Example: client_identifier

externalClientId string

Chave de identificação do cliente externo. Utilizada para identificar o cliente que está realizando a requisição. Populado pelo campo enviado no header base39-external-client-id.

app string

Nome da aplicação que criou a assinatura.

Example: backoffice

Example (from schema)

{
  "id": "subs_5f92f01728e009f403d8502e",
  "name": "Loan created webhook",
  "events": [
    {
      "eventType": "loan.created",
      "filters": {
        "status": [
          "canceled",
          "open"
        ]
      }
    }
  ],
  "notification": {
    "url": "https://api.example.com/webhooks",
    "headers": {
      "Authorization": "key-12345"
    }
  },
  "createdBy": {
    "clientId": "client_identifier",
    "externalClientId": "string",
    "app": "backoffice"
  },
  "updatedBy": {
    "clientId": "client_identifier",
    "externalClientId": "string",
    "app": "backoffice"
  }
}

Loading...