Skip to main content
POST
cURL

Authorizations

Authorization
string
header
required

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

Headers

idempotency-key
string

Idempotency key for this request. Will return the same response if the same request is made again with the same key. Fails if parameters are different.

Body

application/json
url
string<uri>
required

URL HTTPS que vai receber os eventos.

Example:

"https://exemplo.com.br/webhooks/salvy"

eventTypes
string[]
required

Tipos de evento que o endpoint vai receber, sem repetição. Os tipos disponíveis estão em GET /webhook-event-types.

Minimum array length: 1
Minimum string length: 1
Example:
description
string | null

Descrição para identificar o endpoint.

Example:

"Integração com o ERP"

Response

id
string
required

ID do endpoint de webhook.

Example:

"ep_2yZwUhtgs5Ai8T9yRQJXA"

url
string<uri>
required

URL HTTPS que recebe os eventos.

Example:

"https://exemplo.com.br/webhooks/salvy"

eventTypes
string[]
required

Tipos de evento enviados a este endpoint. Um endpoint sem filtro de eventos recebe todos os tipos e lista todos os disponíveis em GET /webhook-event-types.

Example:
description
string | null
required

Descrição do endpoint; null quando não informada.

Example:

"Integração com o ERP"

disabled
boolean
required

Indica se o endpoint está desativado. Um endpoint desativado não recebe eventos.

Example:

false

createdAt
string<date-time>
required

Data e hora de criação do endpoint (ISO 8601, UTC).

Pattern: ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d:[0-5]\d(?:\.\d+)?(?:Z))$
Example:

"2026-10-13T14:30:00.000Z"

secret
string
required

Segredo usado para verificar a assinatura dos eventos entregues a este endpoint. Retornado apenas na criação: guarde-o em local seguro.

Example:

"whsec_C2FVsBQIhrscChlQIMV+b5sSYspob7oD"