Saltar para o conteúdo principal
POST
Criar endpoint de webhook
Regista um novo endpoint de webhook para o inquilino autenticado. O endpoint recebe pedidos HTTP POST quando ocorrem eventos correspondentes. O segredo do endpoint é devolvido uma vez na resposta — armazene-o de forma segura.
O número de endpoints de webhook que você pode criar depende do seu plano de faturamento. Se você exceder o limite do seu plano, a API retornará 402 Payment Required.

Respostas

O campo secret é retornado apenas na resposta de criação. Armazene-o com segurança — você não poderá recuperá-lo mais tarde. Se você o perder, gire o segredo para gerar um novo.

Autorizações

X-API-Key
string
header
obrigatório

Chave de API para autenticação máquina a máquina

Corpo

application/json
name
string
obrigatório

Nome do endpoint legível por humanos

url
string
obrigatório

URL HTTPS para entregas de webhook

event_filters
string[]
obrigatório

Tipos de evento ou padrões curinga

Resposta

Endpoint criado

id
string
name
string
url
string
status
string
secret
string
event_filters
string[]
created_at
string