Growth OS API
Referência da APIWebhooks

Atualizar assinatura de webhook

PATCH
/webhooks/{id}

Autorização

apiKey
AutorizaçãoBearer <token>

Chave de API (gos_…)

Em: header

Parâmetros de caminho

id*string
Length1 <= length

Corpo da requisição

application/json

Definições TypeScript

Use o tipo request body no TypeScript.

Corpo da resposta

application/json

curl -X PATCH "https://example.com/webhooks/string" \  -H "Content-Type: application/json" \  -d '{}'
{  "id": "string",  "url": "string",  "events": [    "contact.created"  ],  "active": true,  "failingSince": "string",  "disabledReason": "string",  "createdAt": "string",  "updatedAt": "string"}

Listar tarefas

Página anterior

Criar assinatura de webhook

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"`).