Pular para o conteúdo principal

SubscriptionCreate

Criar uma assinatura

namestringrequired

Nome da assinatura.

Example: Loan created webhook
events object[]required

Lista de eventos.

  • Array [
  • eventTypestring

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

    Example: loan.created
    filtersobject

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

    Example: {"status":["canceled","open"]}
  • ]
  • notification objectrequired
    urlstring

    Url que será utilizada para o envio do evento.

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

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

    Example: {"Authorization":"key-12345"}
    SubscriptionCreate
    {
    "name": "Loan created webhook",
    "events": [
    {
    "eventType": "loan.created",
    "filters": {
    "status": [
    "canceled",
    "open"
    ]
    }
    }
    ],
    "notification": {
    "url": "https://api.example.com/webhooks",
    "headers": {
    "Authorization": "key-12345"
    }
    }
    }