/api/v1/webhooksLista as assinaturas de webhook do cliente OAuth
Sem autenticação
Headers
| Authorization | Obrigatório | Bearer <access_token> |
| X-Request-Id | Opcional | Ecoado na resposta |
Respostas
/api/v1/webhooksCria uma assinatura de webhook e retorna o signing_secret uma única vez
Sem autenticação
Headers
| Authorization | Obrigatório | Bearer <access_token> |
| Content-Type | Obrigatório | application/json |
| Idempotency-Key | Recomendado | ULID, janela de 24h |
| X-Request-Id | Opcional | Ecoado na resposta |
Corpo da requisição*
| Campo | Tipo | Restrições | Descrição |
|---|---|---|---|
| url* | string·uri | — | — |
| topics* | string[] | — | — |
| description | string | — | — |
Respostas
/api/v1/webhooks/{publicId}Exibe uma assinatura específica (URL, tópicos, status)
Sem autenticação
Headers
| Authorization | Obrigatório | Bearer <access_token> |
| X-Request-Id | Opcional | Ecoado na resposta |
Parâmetros
| Parâmetro | Local | Tipo | Descrição |
|---|---|---|---|
| publicId* | path | string | — |
Respostas
/api/v1/webhooks/{publicId}Atualiza a URL, tópicos ou status de uma assinatura
Sem autenticação
Headers
| Authorization | Obrigatório | Bearer <access_token> |
| Content-Type | Obrigatório | application/json |
| Idempotency-Key | Recomendado | ULID, janela de 24h |
| X-Request-Id | Opcional | Ecoado na resposta |
Parâmetros
| Parâmetro | Local | Tipo | Descrição |
|---|---|---|---|
| publicId* | path | string | — |
Corpo da requisição*
| Campo | Tipo | Restrições | Descrição |
|---|---|---|---|
| url | string·uri | — | — |
| topics | string[] | — | — |
| status | string | active | paused | — |
| description | string | nullable | — |
Respostas
/api/v1/webhooks/{publicId}Remove uma assinatura, parando todas as entregas futuras
Sem autenticação
Headers
| Authorization | Obrigatório | Bearer <access_token> |
| Idempotency-Key | Recomendado | ULID, janela de 24h |
| X-Request-Id | Opcional | Ecoado na resposta |
Parâmetros
| Parâmetro | Local | Tipo | Descrição |
|---|---|---|---|
| publicId* | path | string | — |
Respostas
/api/v1/webhooks/{publicId}/rotate-secretGera um novo signing_secret (invalida o anterior imediatamente)
Sem autenticação
Headers
| Authorization | Obrigatório | Bearer <access_token> |
| Idempotency-Key | Recomendado | ULID, janela de 24h |
| X-Request-Id | Opcional | Ecoado na resposta |
Parâmetros
| Parâmetro | Local | Tipo | Descrição |
|---|---|---|---|
| publicId* | path | string | — |
Respostas
/api/v1/webhooks/{publicId}/deliveriesHistórico de entregas com status, tentativa e código HTTP de resposta
Sem autenticação
Headers
| Authorization | Obrigatório | Bearer <access_token> |
| X-Request-Id | Opcional | Ecoado na resposta |
Parâmetros
| Parâmetro | Local | Tipo | Descrição |
|---|---|---|---|
| publicId* | path | string | — |
Respostas