POST/api/v1/webhooks

Criar Webhook

Cria um novo endpoint que receberá eventos via POST. O secret HMAC é retornado UMA vez na resposta — salve em local seguro.

Escopowrite + webhooks

Corpo da requisição

Parâmetro	Tipo	Descrição
name required	string	Nome de identificação.
url required	string	URL alvo (HTTPS recomendado).
events required	string[]	Lista de eventos. Ex: sale.paid, sale.refunded, subscription.cancelled. Ver lista completa abaixo.
description	string	Descrição livre.

Exemplo de requisição

bash

curl -X POST https://devexpay-v3.vercel.app/api/v1/webhooks \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "CRM Zapier",
    "url": "https://hooks.zapier.com/...",
    "events": ["sale.paid", "sale.refunded"]
  }'

Resposta

json

{
  "id": "be6a...",
  "name": "CRM Zapier",
  "url": "https://hooks.zapier.com/...",
  "events": ["sale.paid", "sale.refunded"],
  "is_active": true,
  "created_at": "2026-06-08T12:00:00Z",
  "secret": "whsec_xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx"
}

Estrutura da resposta

Parâmetro	Tipo	Descrição
secret	string	Secret HMAC SHA-256. Use para validar X-Devexpay-Signature em cada evento recebido. Aparece APENAS aqui.