Saltar para o conteúdo principal
POST
Regista um URL HTTPS que recebe eventos de webhook. A tua chave de API é a proprietária do webhook. Este recebe um evento apenas para objetos que a tua chave consegue ler. Uma chave de API pode ter no máximo 5 webhooks.
Requer o âmbito webhooks_manage.

Pedido

Parâmetros do corpo

string
obrigatório
URL HTTPS na porta 443 com um host público e sem credenciais. A Aniva não segue redirecionamentos.
string[]
obrigatório
Tipos de eventos a receber, pelo menos um. ["*"] significa todos os tipos. ping não pode ser listado.
string[]
obrigatório
1 a 5 endereços para os quais a Aniva envia email quando as entregas continuam a falhar.
string
Texto livre para a tua própria referência, no máximo 500 caracteres.

Resposta

Em caso de sucesso, a API devolve 201 Created com o webhook e o seu segredo.
string
obrigatório
O segredo de assinatura, whsec_ seguido de base64. A Aniva mostra-o apenas nesta resposta. Consulta Verificar a assinatura.
string
obrigatório
Identificador do webhook (UUID).
string
obrigatório
O URL HTTPS para o qual a Aniva envia os eventos.
string
Texto livre para a tua própria referência. Pode ser null.
string[]
obrigatório
Tipos de eventos que este webhook recebe. * significa todos os tipos.
string[]
obrigatório
Endereços para os quais a Aniva envia email quando as entregas continuam a falhar.
string
obrigatório
enabled ou disabled.
string
Instante ISO 8601 UTC em que o webhook foi desativado. null enquanto estiver ativo.
string
Motivo pelo qual o webhook foi desativado. Consulta Avisos de falha. null enquanto estiver ativo.
string
Instante ISO 8601 UTC em que começou a sequência atual de falhas. null quando a última entrega teve sucesso.
string
Instante ISO 8601 UTC em que o segredo anterior deixa de assinar. null quando não há rotação em curso.
string
obrigatório
Instante ISO 8601 UTC em que o webhook foi criado.
string
obrigatório
Instante ISO 8601 UTC da última alteração.

Respostas de erro