Criar webhook

POST

/webhooks

Cria um webhook. A resposta inclui o token (segredo de assinatura) —
este é o único momento em que ele aparece. Guarde-o; se perder, use
POST /webhooks/{webhook}/rotate-secret para gerar um novo.

Requisição

Authorization

Forneça seu token bearer no cabeçalho

Authorization

ao fazer requisições para recursos protegidos.

Exemplo:

Authorization: Bearer ********************

Parâmetros Bodyapplication/jsonObrigatório

Examples

Respostas

🟢201

application/json

Webhook criado. Contém o token (exibido uma única vez).

Bodyapplication/json

🟠401Unauthorized

🟠422ValidationError

Request Example

Shell

JavaScript

Java

Swift

curl --location '/webhooks' \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '{
    "title": "Minhas vendas",
    "url": "https://seller.exemplo.com/webhooks/syncpay",
    "event": "transaction",
    "trigger_all_products": true,
    "product_reference_ids": [
        "497f6eca-6276-4993-bfeb-53cbbbba6f08"
    ]
}'

Response Example

201 - Exemplo 1

{
    "id": 0,
    "title": "string",
    "url": "http://example.com",
    "event": "string",
    "trigger_all_products": true,
    "products": [
        {
            "reference_id": "97c1ff22-6e4f-4821-b1d3-5236781d37b8",
            "name": "string"
        }
    ],
    "created_at": "2026-08-16 14:30:02",
    "token": "string"
}

Modificado em 2026-08-17 00:11:01