Saltar para o conteúdo principal
PATCH
Altera um webhook. Envia apenas os campos que queres alterar. Envia status: "enabled" para voltar a ativar um webhook desativado. Vê Avisos de falha.
Requer o âmbito webhooks_manage.

Pedido

Parâmetros de caminho

string
obrigatório
Identificador do webhook (UUID).

Parâmetros do corpo

string
Novo URL HTTPS. As mesmas regras que em Criar.
string[]
Nova lista de tipos de eventos. Substitui a lista antiga.
string[]
Nova lista de 1 a 5 endereços. Substitui a lista antiga.
string
Nova descrição, no máximo 500 caracteres. null limpa-a.
string
enabled ou disabled. Desativar cancela as entregas pendentes.

Resposta

Em caso de sucesso, a API devolve 200 OK com o webhook atualizado.
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