Subscription

Este objeto representa uma assinatura.

string

Identificador exclusivo para o objeto.

Example:

"subs_5f92f01728e009f403d8502e"

name

string

Nome da assinatura.

Example:

"Loan created webhook"

events

object[]

Lista de eventos.

events.eventType

string

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

Example:

"loan.created"

events.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

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" }

createdBy

object

updatedBy

object

ProductsEligibles Subscriptions

{
  "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"
  }
}

Empréstimos

Empresas

Clientes

Fundos

Eventos

Cobrança

Arquivos

Configurações

Entidades

Automações

Modelos