v1

latestOpenAPI 3.0.42026-07-24150552428.5 KB

Alterar a secret de um webhook

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

Path parameters

companyIdstring required

CNPJ da empresa

Example:1234124210002

appIdstring required

Assume o valor do seu Client Id

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

webhookIdstring required

Id único de um webhook cadastrado

Example:1111111-b11f-48c3-9a0e-11111111111

Request body

valuestring

Valor utilizado para gerar a secret

Example request

{
  "value": "my-example-key"
}

Response

Success

webhookIdstring

Id único de um webhook cadastrado

idAliasstring

Alias que pode ser atribuido ao webhook

appIdstring

Assume o valor do seu Client Id

endpointstring

URL que deseja cadastrar no webhook

descriptionstring

Descrição do webhook

tagsstring

Tag do webhook

disabledboolean

Campo referente ao status de funcionamento do webhook

secretstring

secret key do webhook

keystring

eventsstring[]

Eventos que deseja assinar no webhook

Example response

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