Sign in

v1

latestOpenAPI 3.0.42026-07-24150552428.5 KB
Webhook

Criar um webhook

post/{companyId}/apps/{appId}/webhooks

Path parameters

companyIdstring required

CNPJ da empresa

Example:1234124210002
appIdstring required

Assume o valor do seu Client Id

Example:1111111111-a78c-447b-b5fe-1111111111

Request body

appIdstring required

clientId

endpointstring required

Endpoint do webhook a ser criado

descriptionstring

Descrição do webhook

eventsstring[] required

eventos dos produtos que deseja receber

messageFilterobject

Opção para filtrar mensagem de webhook com base em um valor da mensagem recebida

tagsobject

tags do webhook

idAliasstring
secretstring

Response

Success

webhookIdstring

Id único de um webhook cadastrado

appIdstring

Assume o valor do seu Client Id

endpointstring

URL que deseja cadastrar no webhook

keystring
eventsstring[]

Eventos que deseja assinar no webhook

secretstring

secret key do webhook

Example response

{
  "webhookId": "1111111-b11f-48c3-9a0e-11111111111",
  "appId": "1111111111-a78c-447b-b5fe-1111111111",
  "endpoint": "https://localhost.com/test",
  "key": "11111111111-4ba6-b69e-11111111111",
  "events": [
    "bank-slips.*"
  ],
  "secret": "1111111111-1a15-4aea-8d06-111111111"
}