Criar novo Webhook pela API

Você pode criar novos Webhooks através da API, tanto para contas raiz quanto para subcontas. Você pode ter até 10 Webhooks configurados na sua conta e é você quem escolhe quais eventos cada Webhook irá receber.

Para criar um novo Webhook, vamos realizar uma chamada ao endpoint de Criar novo Webhook.

POST /v3/webhooks
Confira a referência completa deste endpoint

{
    "name": "Nome Exemplo",
    "url": "https://www.exemplo.com/webhook/asaas",
    "email": "[email protected]",
    "enabled": true,
    "interrupted": false,
    "authToken": null,
    "sendType": "SEQUENTIALLY",
    "events": [
        "PAYMENT_CREDIT_CARD_CAPTURE_REFUSED",
        "PAYMENT_CHECKOUT_VIEWED",
        "PAYMENT_BANK_SLIP_VIEWED",
        "PAYMENT_DUNNING_REQUESTED",
        "PAYMENT_DUNNING_RECEIVED",
        "PAYMENT_AWAITING_CHARGEBACK_REVERSAL",
        "PAYMENT_CHARGEBACK_DISPUTE",
        "PAYMENT_CHARGEBACK_REQUESTED",
        "PAYMENT_RECEIVED_IN_CASH_UNDONE",
        "PAYMENT_REFUND_IN_PROGRESS",
        "PAYMENT_REFUNDED",
        "PAYMENT_RESTORED",
        "PAYMENT_DELETED",
        "PAYMENT_OVERDUE",
        "PAYMENT_ANTICIPATED",
        "PAYMENT_RECEIVED",
        "PAYMENT_CONFIRMED",
        "PAYMENT_UPDATED",
        "PAYMENT_CREATED",
        "PAYMENT_REPROVED_BY_RISK_ANALYSIS",
        "PAYMENT_APPROVED_BY_RISK_ANALYSIS",
        "PAYMENT_AWAITING_RISK_ANALYSIS",
        "PAYMENT_AUTHORIZED"
    ]
}

Na chamada acima, criamos um novo Webhook que receberá praticamente todos os eventos de cobrança existentes.

🚧

Token de autenticação(authToken) seguro

O token deve seguir requisitos mínimos de segurança. Um token seguro deve ter:

• Entre 32 e 255 caracteres;
• Nenhum espaço em branco;
• Ausência de sequências numéricas (ex: 12345) ou 4 letras repetidas;
• Não pode ser uma chave de API Asaas.

Para simplificar sua integração, mantivemos a auto-geração via API caso o campo não seja enviado no momento da criação.

Este valor será retornado apenas uma vez no corpo da resposta de criação. Certifique-se de capturá-lo para configurar seu servidor.

Pela API você também pode editar ou excluir os Webhooks da sua conta.

Para listar todas as configurações de Webhook, utilize o endpoint como uma chamada GET.

GET /v3/webhooks
Confira a referência completa deste endpoint

A partir deste entpoint você também pode verificar quais dos seus Webhooks estão com a fila interrompida.