Criar assinatura

Cria uma nova assinatura.

Authorizations

Authorization

string

header

required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Headers

Idempotency-Key

string

Chave única de idempotência para evitar duplicação de requisições.

Body

application/json

Criar uma assinatura

name

string

required

Nome da assinatura.

Example:

"Loan created webhook"

events

object[]

required

Lista de eventos.

Show child attributes

events.eventType

string

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

Example:

"loan.created"

notification

object

required

Show child attributes

notification.url

string

Url que será utilizada para o envio do evento.

Example:

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

notification.headers

object

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

Example:

{ "Authorization": "key-12345" }

Response

201 - application/json

Retorna o objeto `Subscription` se a criação for bem-sucedida. Retorna um erro se os parâmetros de criação forem inválidos.

Este objeto representa uma assinatura.

id

string

Identificador exclusivo para o objeto.

Example:

"subs_5f92f01728e009f403d8502e"

name

string

Nome da assinatura.

Example:

"Loan created webhook"

events

object[]

Lista de eventos.

Show child attributes

events.eventType

string

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

Example:

"loan.created"

notification

object

Show child attributes

notification.url

string

Url que será utilizada para o envio do evento.

Example:

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

notification.headers

object

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

Example:

{ "Authorization": "key-12345" }