Webhooks
Cadastrar configuração de webhook
Cadastra o endpoint HTTP que receberá eventos do produto, como
POST/integration/v1/webhooks
Corpo da requisição
| Campo | Tipo | Descrição |
|---|---|---|
| ref | string (uuid) | Exemplo: "bbbbbbbb-1111-2222-3333-444444444444" |
| eventType* | enum: PIX_DYNAMIC_PAID | PIX_STATIC | PIX_REVERSAL | PIX_OUT | Exemplo: "PIX_DYNAMIC_PAID" |
| endpointUrl* | string (uri) | Exemplo: "https://cliente.exemplo.com/webhooks/pix" |
| applicationId | string | Exemplo: "erp-integracao" |
| enabled | boolean | Exemplo: true |
Exemplo de requisição
curl -X POST https://apiapp.dev.ideabank.com.br/integration/v1/webhooks \
-H "Authorization: Bearer $TOKEN" \
-H "tenantid: $TENANT_ID" -H "hostdevelop: apiapp.dev.ideabank.com.br" -H "Content-Type: application/json" \
-d '{
"ref": "bbbbbbbb-1111-2222-3333-444444444444",
"eventType": "PIX_DYNAMIC_PAID",
"endpointUrl": "https://cliente.exemplo.com/webhooks/pix",
"applicationId": "erp-integracao",
"enabled": true
}'Códigos de resposta
| HTTP | Descrição |
|---|---|
| 200 | Webhook configurado com sucesso |
| 401 | |
| 403 | |
| 422 | |
| 500 |
Fonte
Esta página é gerada a partir do Swagger oficial. Para o payload autoritativo, consulte também a especificação viva.