Webhooks

4 operações em Quadra Command API 0.2.0.

POST/v1/webhooks

Register a webhook endpoint

The plaintext ``secret`` appears ONLY in this 201 — every later read (including an idempotent replay of this request) returns the masked form. Errors: 409: IDEMPOTENCY_KEY_REUSED 422: INVALID_EVENT_FILTER, URL_SCHEME_NOT_HTTPS, URL_PRIVATE_ADDRESS, URL_MALFORMED, URL_UNRESOLVABLE, WEBHOOK_LIMIT_EXCEEDED

Parâmetros

Nome	Tipo	Detalhe
Idempotency-Key	string	headerobrigatório

Corpo da requisição

WebhookCreateRequest — obrigatório. Os campos estão listados em Esquemas, abaixo.

Respostas

Status	Corpo	Detalhe
201	—	Resposta bem-sucedidaO contrato não declara um modelo para esta resposta, então a forma dela não está documentada aqui. Um roteiro de demonstração mostra a forma que ela realmente devolve.
422	HTTPValidationError	Erro de validação

DELETE/v1/webhooks/{webhook_id}

Delete a webhook endpoint (tombstone)

Tombstone (status=DELETED, idempotent): delivery history remains readable until its TTL. Errors: 404: WEBHOOK_NOT_FOUND.

Parâmetros

Nome	Tipo	Detalhe
webhook_id	string	pathobrigatório

Respostas

Status	Corpo	Detalhe
200	—	Resposta bem-sucedidaO contrato não declara um modelo para esta resposta, então a forma dela não está documentada aqui. Um roteiro de demonstração mostra a forma que ela realmente devolve.
422	HTTPValidationError	Erro de validação

PATCH/v1/webhooks/{webhook_id}

Update a webhook endpoint

Update url / event_filters / status (secret immutable). PATCHing status=ACTIVE from a suspended state resets the failure streak. Errors: 400: NO_UPDATABLE_FIELDS 404: WEBHOOK_NOT_FOUND 409: WEBHOOK_DELETED 422: INVALID_EVENT_FILTER, URL_*

Parâmetros

Nome	Tipo	Detalhe
webhook_id	string	pathobrigatório

Corpo da requisição

WebhookPatchRequest — obrigatório. Os campos estão listados em Esquemas, abaixo.

Respostas

Status	Corpo	Detalhe
200	—	Resposta bem-sucedidaO contrato não declara um modelo para esta resposta, então a forma dela não está documentada aqui. Um roteiro de demonstração mostra a forma que ela realmente devolve.
422	HTTPValidationError	Erro de validação

POST/v1/webhooks/{webhook_id}/test

Send a signed webhook.test delivery

Enqueue one synthetic ``webhook.test`` delivery to exactly this endpoint (bypasses filters; delivery row flagged test — never an EVENT# browse row). Errors: 404: WEBHOOK_NOT_FOUND 409: WEBHOOK_DELETED, WEBHOOK_NOT_ACTIVE 503: DISPATCHER_UNAVAILABLE (local).

Parâmetros

Nome	Tipo	Detalhe
webhook_id	string	pathobrigatório
Idempotency-Key	string	headerobrigatório

Respostas

Status	Corpo	Detalhe
202	—	Resposta bem-sucedidaO contrato não declara um modelo para esta resposta, então a forma dela não está documentada aqui. Um roteiro de demonstração mostra a forma que ela realmente devolve.
422	HTTPValidationError	Erro de validação

Esquemas

Os modelos que as operações acima aceitam e devolvem. Campos opcionais estão marcados como tal; um campo tipado como outro modelo está documentado sob o nome dele.

HTTPValidationError

Campo	Tipo	Detalhe
detail	array de ValidationError

ValidationError

Campo	Tipo	Detalhe
ctx	object
input	não declarado
loc	array de string ou integer	obrigatório
msg	string	obrigatório
type	string	obrigatório

WebhookCreateRequest

Campo	Tipo	Detalhe
description	string, opcional
event_filters	array de string	obrigatório
url	string	obrigatório

WebhookPatchRequest

url / event_filters / status only — the secret is immutable (rotation = delete + re-create, webhooks-v1 §3). SUSPENDED_AUTO is dispatcher-set; owners can PATCH to ACTIVE (resets the failure streak) or SUSPENDED.

Campo	Tipo	Detalhe
event_filters	array de string, opcional
status	"ACTIVE" \| "SUSPENDED", opcional
url	string, opcional

← Quadra Command API Chamar no playground →