Skip to main content
POST
Criar endpoint de webhook

Body

application/json
name
string
required

Nome legível do endpoint de webhook.

Required string length: 1 - 128
Example:

"Frontend callback"

subscribed_events
enum<string>[]
required

Tipos de evento de webhook entregues a este endpoint.

Minimum array length: 1
Available options:
webhook.test,
adverse_media.completed,
adverse_media.failed
Example:
url
string
required

URL de destino HTTPS que vai receber os eventos de webhook.

Required string length: 1 - 2048
Example:

"https://example.com/webhooks/nllabs"

Response

Successful Response

consecutive_failures
integer
required

Contagem atual de falhas de entrega consecutivas.

created_at
string<date-time>
required

Timestamp de criação do endpoint.

disabled_at
string<date-time> | null
required

Timestamp de quando o endpoint foi desativado.

last_failure_at
string<date-time> | null
required

Timestamp da última entrega com falha.

last_success_at
string<date-time> | null
required

Timestamp da última entrega bem-sucedida.

name
string
required

Nome legível do endpoint de webhook.

secret
string
required

Segredo de assinatura em texto puro, retornado só uma vez.

status
enum<string>
required

Status do ciclo de vida do endpoint.

Available options:
active,
disabled
subscribed_events
enum<string>[]
required

Tipos de evento assinados.

Available options:
webhook.test,
adverse_media.completed,
adverse_media.failed
updated_at
string<date-time>
required

Timestamp da última atualização do endpoint.

url
string
required

URL de destino.

uuid
string<uuid>
required

UUID do endpoint de webhook.