Pular para o conteúdo
Webhooks

Atualizar assinatura de webhook

v1.0.0
PATCHhttps://api.staging.growthaisystem.com/api/v1/webhooks/{id}
  • ExigeAuthorization: Bearer gos_…— Chave de API (gos_…)· escoposwebhooks.manage

Parâmetros de caminho

Entram no próprio endereço, no lugar das chaves.

  • idstringobrigatório
    • tamanho mín. 1

Corpo da requisição

application/jsonobrigatório
  • urlstring (uri)opcional
    • tamanho máx. 2000
  • eventsstring[]opcional
    • itens mín. 1
  • activebooleanopcional

Respostas

9 respostas documentadas — o código, o que ele significa nesta rota e a forma do corpo.

200Deu certoapplication/json

Assinatura depois da alteração. Reativar com active: true também zera failingSince e disabledReason — o circuit breaker recomeça do zero.

V1WebhookSubscription

  • idstring
  • urlstring
  • eventsstring[]
  • activeboolean
  • failingSincestring | null
  • disabledReasonstring | null
  • createdAtstring
  • updatedAtstring