Skip to main content
POST
Criar um webhook
Requer a permissão WEBHOOK:CREATE.

Authorizations

Authorization
string
header
required

Todas as requisições devem incluir sua chave de API no header Authorization usando o formato Bearer <abacatepay-api-key>. Sem esse header a requisição será rejeitada.

Saiba mais sobre como criar e usar chaves de API na documentação de autenticação.

Body

application/json

Dados para criação de um webhook.

name
string
required

Nome identificador do webhook

Example:

"Webhook de Pagamentos"

endpoint
string
required

URL HTTPS que receberá as notificações de eventos

Example:

"https://meusite.com/webhooks/abacatepay"

secret
string
required

Sua chave usada para autenticar nosso webhook

Example:

"meu-secret-seguro"

events
enum<string>[]
required

Lista de eventos que este webhook deve receber

Available options:
checkout.completed,
checkout.refunded,
checkout.disputed,
checkout.lost,
transparent.completed,
transparent.refunded,
transparent.disputed,
transparent.lost,
subscription.completed,
subscription.trial_started,
subscription.cancelled,
subscription.renewed,
payout.completed,
payout.failed,
transfer.completed,
transfer.failed
Example:

Response

Webhook criado com sucesso.

data
object

Os dados do webhook.

error
string | null
Example:

null

success
boolean

Se a requisição obteve sucesso ou não.

Example:

true