Pular para o conteúdo principal
POST
Create a webhook endpoint

Autorizações

Authorization
string
header
obrigatório

API key, sent as Authorization: Bearer unite_live_.... Create keys in the workspace settings.

Corpo

application/json
url
string
obrigatório

HTTPS address that receives the events. It must be reachable from the internet; private addresses are refused.

Maximum string length: 2048
events
enum<string>[]
obrigatório

Event types this endpoint receives. At least one, without repeats.

Minimum array length: 1
Opções disponíveis:
pretest.completed,
pretest.failed,
pretest.report_ready
description
string

Free text to tell your endpoints apart.

Maximum string length: 200

Resposta

The endpoint, with its signing secret.

id
string
obrigatório
object
string
obrigatório
Allowed value: "webhook_endpoint"
url
string
obrigatório
description
string | null
obrigatório
events
enum<string>[]
obrigatório
Opções disponíveis:
pretest.completed,
pretest.failed,
pretest.report_ready
status
enum<string>
obrigatório

A disabled endpoint receives no events.

Opções disponíveis:
enabled,
disabled
disabledReason
string | null
obrigatório

Why the endpoint was disabled: gone when your server answered 410 to a delivery, or creator_removed when the member who created the endpoint left the workspace. Null while enabled.

createdAt
string
obrigatório

ISO 8601 UTC.

secret
string
obrigatório

Signing secret (whsec_...). It is shown only in this response: store it now. Use it to verify the webhook-signature header.