Skip to main content
POST
Cadastrar webhook
Cadastra um endpoint HTTPS para receber notificações de eventos. A URL é testada com um POST no momento do cadastro.
Esta rota devolve o signatureSecret em texto puro na resposta, e GET /v1/webhook volta a mostrá-lo a cada listagem. Trate-o como segredo no seu log. Ele não é usado para assinar as entregas hoje — veja Verificação e segurança antes de construir qualquer validação em cima dele.
Esta é a rota legada. Ela grava na mesma coleção de POST /v1/webhooks, a API do vendedor: o webhook criado aqui aparece lá com o mesmo id, e vice-versa. Cadastrar o mesmo endpoint nas duas rotas cria dois webhooks para a mesma URL e duplica cada entrega. Em integrações novas, use /v1/webhooks.
Veja todos os eventos disponíveis e seus payloads em Webhooks › Eventos.

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json
url
string<uri>
required
Example:

"https://seusite.com/webhooks/ephra"

events
enum<string>[]
required
Available options:
transaction_created,
transaction_paid,
transaction_refunded,
transaction_updated,
transfer_created,
transfer_completed,
transfer_canceled,
transfer_updated,
infraction,
card_declined,
sale_lost,
cart_abandoned,
product_canceled
Example:
name
string | null
Example:

"Produção"

isActive
boolean
default:true
productIds
string[]

Limita o webhook a produtos específicos. Omitido = todos.

Response

Webhook criado

success
boolean
Example:

true

data
object