Pular para o conteúdo
Webhooks

Criar assinatura de webhook

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

O secret de assinatura (X-Gos-Signature) aparece uma única vez, nesta resposta — não há rota que o devolva depois. Cada evento assinado exige o escopo de leitura correspondente (ex.: contact.created exige contacts.read), além de webhooks.manage. Se o escopo dessa chave for revogado depois, a entrega desativa a assinatura sozinha (disabledReason: "scope_revoked").

Corpo da requisição

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

Respostas

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

201Deu certoapplication/json

Assinatura criada e já ativa, junto do secret de assinatura HMAC — este é o único momento em que o segredo existe fora do seu servidor: guarde-o agora, não há rota que o devolva depois.

V1WebhookSubscriptionCriada

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