---
updatedAt: 2026-06-24T18:34:53.000Z
agentTools:
projectIndex: https://docs.asaas.com/llms.txt
---
# Create new Webhook
### Webhooks Guide
Check the Webhooks guide for more information.
This endpoint allows you to create a new webhook to receive automatic notifications about events that occur in your Asaas account.
Webhooks are used to keep systems synchronized without the need for frequent API requests. Whenever a configured event occurs, a notification will be sent to the registered URL.
***
## When to use
This endpoint is recommended for integrations that need to react automatically to platform events, such as:
* payment confirmations;
* invoice due dates;
* cancellations;
* refunds;
* subscription changes;
* events related to Pix, transfers, and other API resources.
Instead of constantly querying API resources, it is recommended to use webhooks to receive real-time updates.
***
## Dependencies
Before creating a webhook, it is necessary to:
* have an active Asaas account;
* have valid API authentication;
* provide a publicly accessible URL;
* define which events should be monitored;
* have an application capable of processing the received notifications.
Without these conditions, the webhook cannot be created properly.
***
## Webhook events
When configuring the webhook, you must specify which events should generate notifications.
> 📘 Available events
>
> Check [the complete list of supported events](https://docs.asaas.com/docs/eventos-de-webhooks) to define which notifications will be received.
***
## Parameters used
| Parameter | Description |
| ------------- | ----------------------------------------------------------------------------------------------------------- |
| `name` | Webhook name. |
| `url` | Destination URL that will receive event notifications. |
| `email` | Email address that will receive notifications related to the webhook. |
| `enabled` | Defines whether the webhook will be active. |
| `interrupted` | Defines whether the synchronization queue will be interrupted. |
| `apiVersion` | API version used by the webhook. |
| `authToken` | Authentication token used to validate received notifications. |
| `sendType` | Defines whether events will be sent sequentially (`SEQUENTIALLY`) or non-sequentially (`NON_SEQUENTIALLY`). |
| `events` | List of events that should generate notifications for the webhook. |
> 📘 Important
>
> The `authToken` parameter must contain between 32 and 255 characters and should be stored securely.
***
## Operation behavior
After creating the webhook, the flow follows the behavior below:
```text
Webhook created
↓
Event occurs in the Asaas account
↓
Asaas sends the notification
↓
Application processes the event
↓
Integration updates its data
```
Webhooks have a unique identifier (`id`) returned upon creation.
This identifier can later be used to:
* retrieve webhook settings;
* update an existing webhook;
* remove a webhook;
* list webhooks configured in the account.
Notifications are sent to the configured URL, and the receiving system must be prepared to process incoming events.
> 🚧 Attention
>
> It is recommended that event processing be idempotent, preventing duplicate actions if the same event is received more than once.
***
## Request example
```json
{
"name": "Payment webhook",
"url": "https://www.yourapplication.com/webhooks/asaas",
"email": "integration@yourcompany.com",
"enabled": true,
"interrupted": false,
"apiVersion": 3,
"authToken": "secure-token-with-more-than-32-characters",
"sendType": "SEQUENTIALLY",
"events": [
"PAYMENT_RECEIVED",
"PAYMENT_OVERDUE"
]
}
```
In this example, the webhook will be created as active and will send notifications to the configured URL whenever a payment is received or becomes overdue.
***
## Important considerations
> 🚧 Attention
>
> It is recommended to use a strong `authToken` to validate the origin of notifications.
In addition:
* the configured URL must be available to receive requests;
* event processing must be idempotent to avoid duplicates;
* the system must respond properly to received notifications;
* it is recommended to monitor synchronization failures and downtime.
***
## Usage example
A common flow consists of:
```text
Create webhook
↓
Select PAYMENT_RECEIVED
↓
Customer makes a payment
↓
Asaas sends the notification
↓
System automatically updates the order
```
***
## Best practices
* Configure only the events required by your integration.
* Use a dedicated URL to receive Asaas events.
* Validate the received `authToken` before processing the notification.
* Log received events for auditing and troubleshooting purposes.
* Implement idempotent processing to avoid duplicate actions.
* Monitor delivery failures and webhook queue interruptions.
> 📘 Important
>
> After creating the webhook, it is recommended to perform tests to ensure that events are being received and processed correctly.
***
## Common errors
### Invalid or inaccessible URL
Occurs when the provided URL is not publicly available or does not accept external requests.
### Invalid authToken
May occur when the provided token does not meet the minimum requirements or is not properly validated by the receiving application.
### Events not configured
May occur when no relevant events have been selected to send notifications.
### Interrupted queue
When the synchronization queue is interrupted, events are no longer sent normally.
### Duplicate processing
May occur when the receiving application does not implement idempotent event handling.
***
## Operational impacts
Downtime of the configured URL or failures during processing may cause delays in synchronization between systems.
For this reason, it is recommended to:
* monitor webhook deliveries;
* maintain high availability of the receiving application;
* log received notifications;
* validate the authenticity of messages using the `authToken`;
* monitor possible synchronization queue interruptions.
***
## Next steps
Depending on your integration requirements, the following contents may complement the implementation:
* Retrieve webhook;
* Update webhook;
* Remove webhook;
* Process events received by the integration.
> 🚧 Attention
>
> Webhooks have an identifier (`id`). Use this identifier to retrieve, update, or remove the resource later.
# OpenAPI definition
```json
{
"openapi": "3.0.1",
"info": {
"title": "Asaas",
"description": "API pública de integração com a plataforma Asaas.",
"version": "3.0.0"
},
"servers": [
{
"url": "https://api-sandbox.asaas.com",
"description": "Sandbox"
}
],
"security": [
{
"Authorization": []
}
],
"tags": [
{
"name": "Webhook"
}
],
"paths": {
"/v3/webhooks": {
"post": {
"tags": [
"Webhook"
],
"summary": "Create new Webhook",
"description": "",
"operationId": "create-new-webhook",
"parameters": [],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/WebhookConfigSaveRequestDTO"
}
}
}
},
"responses": {
"200": {
"description": "Ok",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/WebhookConfigGetResponseDTO"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponseDTO"
},
"example": {
"errors": [
{
"code": "error_code",
"description": "Error description"
}
]
}
}
}
},
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponseDTO"
},
"example": {
"errors": [
{
"code": "invalid_access_token",
"description": "A chave de API fornecida é inválida"
}
]
}
}
}
}
},
"deprecated": false
}
}
},
"components": {
"schemas": {
"ErrorResponseDTO": {
"type": "object",
"properties": {
"errors": {
"type": "array",
"description": "List of objects",
"deprecated": false,
"items": {
"$ref": "#/components/schemas/ErrorResponseItemDTO"
}
}
}
},
"ErrorResponseItemDTO": {
"type": "object",
"properties": {
"code": {
"type": "string",
"description": "Error code",
"deprecated": false,
"example": null
},
"description": {
"type": "string",
"description": "Error description",
"deprecated": false,
"example": null
}
},
"description": "List of objects",
"deprecated": false
},
"WebhookConfigSaveRequestDTO": {
"required": [
"name",
"url",
"email",
"enabled",
"interrupted",
"apiVersion",
"authToken",
"sendType",
"events"
],
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "Webhook name",
"nullable": false,
"example": "Name Example",
"deprecated": false
},
"url": {
"type": "string",
"description": "Webhook URL",
"nullable": false,
"example": "https://www.example.com/webhook/asaas",
"deprecated": false
},
"email": {
"type": "string",
"description": "Email that will receive notifications about the Webhook",
"nullable": false,
"example": "john.doe@asaas.com.br",
"deprecated": false
},
"enabled": {
"type": "boolean",
"description": "Set whether the Webhook is active",
"nullable": false,
"example": true,
"deprecated": false
},
"interrupted": {
"type": "boolean",
"description": "Set whether the sync queue is stopped",
"nullable": false,
"example": false,
"deprecated": false
},
"apiVersion": {
"type": "integer",
"description": "API Version",
"format": "int32",
"nullable": false,
"example": 3,
"deprecated": false
},
"authToken": {
"maxLength": 255,
"minLength": 32,
"type": "string",
"description": "Webhook authentication token",
"nullable": false,
"example": "whsec_Pxeh17yy3LQbLVpnzz6I1chB7mtzYk5F7pg8bRR80pE",
"deprecated": false
},
"sendType": {
"$ref": "#/components/schemas/WebhookConfigSaveRequestWebhookSendType"
},
"events": {
"type": "array",
"description": "List of events this Webhook will observe",
"nullable": false,
"example": [
"PAYMENT_RECEIVED",
"PAYMENT_CONFIRMED"
],
"deprecated": false,
"items": {
"$ref": "#/components/schemas/WebhookConfigSaveRequestWebhookEvent"
},
"enum": [
"PAYMENT_AUTHORIZED",
"PAYMENT_AWAITING_RISK_ANALYSIS",
"PAYMENT_APPROVED_BY_RISK_ANALYSIS",
"PAYMENT_REPROVED_BY_RISK_ANALYSIS",
"PAYMENT_CREATED",
"PAYMENT_UPDATED",
"PAYMENT_CONFIRMED",
"PAYMENT_RECEIVED",
"PAYMENT_ANTICIPATED",
"PAYMENT_OVERDUE",
"PAYMENT_DELETED",
"PAYMENT_RESTORED",
"PAYMENT_REFUNDED",
"PAYMENT_REFUND_IN_PROGRESS",
"PAYMENT_REFUND_DENIED",
"PAYMENT_RECEIVED_IN_CASH_UNDONE",
"PAYMENT_CHARGEBACK_REQUESTED",
"PAYMENT_CHARGEBACK_DISPUTE",
"PAYMENT_AWAITING_CHARGEBACK_REVERSAL",
"PAYMENT_DUNNING_RECEIVED",
"PAYMENT_DUNNING_REQUESTED",
"PAYMENT_BANK_SLIP_CANCELLED",
"PAYMENT_BANK_SLIP_VIEWED",
"PAYMENT_CHECKOUT_VIEWED",
"PAYMENT_CREDIT_CARD_CAPTURE_REFUSED",
"PAYMENT_PARTIALLY_REFUNDED",
"PAYMENT_SPLIT_CANCELLED",
"PAYMENT_SPLIT_DIVERGENCE_BLOCK",
"PAYMENT_SPLIT_DIVERGENCE_BLOCK_FINISHED",
"PAYMENT_SPLIT_DONE",
"INVOICE_CREATED",
"INVOICE_UPDATED",
"INVOICE_SYNCHRONIZED",
"INVOICE_AUTHORIZED",
"INVOICE_PROCESSING_CANCELLATION",
"INVOICE_CANCELED",
"INVOICE_CANCELLATION_DENIED",
"INVOICE_ERROR",
"TRANSFER_CREATED",
"TRANSFER_PENDING",
"TRANSFER_IN_BANK_PROCESSING",
"TRANSFER_BLOCKED",
"TRANSFER_DONE",
"TRANSFER_FAILED",
"TRANSFER_CANCELLED",
"BILL_CREATED",
"BILL_PENDING",
"BILL_BANK_PROCESSING",
"BILL_PAID",
"BILL_CANCELLED",
"BILL_FAILED",
"BILL_REFUNDED",
"RECEIVABLE_ANTICIPATION_CANCELLED",
"RECEIVABLE_ANTICIPATION_SCHEDULED",
"RECEIVABLE_ANTICIPATION_PENDING",
"RECEIVABLE_ANTICIPATION_CREDITED",
"RECEIVABLE_ANTICIPATION_DEBITED",
"RECEIVABLE_ANTICIPATION_DENIED",
"RECEIVABLE_ANTICIPATION_OVERDUE",
"MOBILE_PHONE_RECHARGE_PENDING",
"MOBILE_PHONE_RECHARGE_CANCELLED",
"MOBILE_PHONE_RECHARGE_CONFIRMED",
"MOBILE_PHONE_RECHARGE_REFUNDED",
"ACCOUNT_STATUS_BANK_ACCOUNT_INFO_APPROVED",
"ACCOUNT_STATUS_BANK_ACCOUNT_INFO_AWAITING_APPROVAL",
"ACCOUNT_STATUS_BANK_ACCOUNT_INFO_PENDING",
"ACCOUNT_STATUS_BANK_ACCOUNT_INFO_REJECTED",
"ACCOUNT_STATUS_COMMERCIAL_INFO_APPROVED",
"ACCOUNT_STATUS_COMMERCIAL_INFO_AWAITING_APPROVAL",
"ACCOUNT_STATUS_COMMERCIAL_INFO_EXPIRED",
"ACCOUNT_STATUS_COMMERCIAL_INFO_EXPIRING_SOON",
"ACCOUNT_STATUS_COMMERCIAL_INFO_PENDING",
"ACCOUNT_STATUS_COMMERCIAL_INFO_REJECTED",
"ACCOUNT_STATUS_DOCUMENT_APPROVED",
"ACCOUNT_STATUS_DOCUMENT_AWAITING_APPROVAL",
"ACCOUNT_STATUS_DOCUMENT_PENDING",
"ACCOUNT_STATUS_DOCUMENT_REJECTED",
"ACCOUNT_STATUS_GENERAL_APPROVAL_APPROVED",
"ACCOUNT_STATUS_GENERAL_APPROVAL_AWAITING_APPROVAL",
"ACCOUNT_STATUS_GENERAL_APPROVAL_PENDING",
"ACCOUNT_STATUS_GENERAL_APPROVAL_REJECTED",
"SUBSCRIPTION_CREATED",
"SUBSCRIPTION_UPDATED",
"SUBSCRIPTION_INACTIVATED",
"SUBSCRIPTION_DELETED",
"SUBSCRIPTION_SPLIT_DISABLED",
"SUBSCRIPTION_SPLIT_DIVERGENCE_BLOCK",
"SUBSCRIPTION_SPLIT_DIVERGENCE_BLOCK_FINISHED",
"CHECKOUT_CREATED",
"CHECKOUT_CANCELED",
"CHECKOUT_EXPIRED",
"CHECKOUT_PAID",
"BALANCE_VALUE_BLOCKED",
"BALANCE_VALUE_UNBLOCKED",
"INTERNAL_TRANSFER_CREDIT",
"INTERNAL_TRANSFER_DEBIT",
"ACCESS_TOKEN_CREATED",
"ACCESS_TOKEN_DELETED",
"ACCESS_TOKEN_DISABLED",
"ACCESS_TOKEN_ENABLED",
"ACCESS_TOKEN_EXPIRED",
"ACCESS_TOKEN_EXPIRING_SOON",
"PIX_AUTOMATIC_RECURRING_AUTHORIZATION_CREATED",
"PIX_AUTOMATIC_RECURRING_AUTHORIZATION_ACTIVATED",
"PIX_AUTOMATIC_RECURRING_AUTHORIZATION_CANCELLED",
"PIX_AUTOMATIC_RECURRING_AUTHORIZATION_EXPIRED",
"PIX_AUTOMATIC_RECURRING_AUTHORIZATION_REFUSED",
"PIX_AUTOMATIC_RECURRING_PAYMENT_INSTRUCTION_CREATED",
"PIX_AUTOMATIC_RECURRING_PAYMENT_INSTRUCTION_SCHEDULED",
"PIX_AUTOMATIC_RECURRING_PAYMENT_INSTRUCTION_REFUSED",
"PIX_AUTOMATIC_RECURRING_PAYMENT_INSTRUCTION_CANCELLED",
"PIX_AUTOMATIC_RECURRING_ELIGIBILITY_UPDATED"
]
}
},
"description": "Array with desired Webhooks settings",
"deprecated": false
},
"WebhookConfigSaveRequestWebhookSendType": {
"type": "string",
"description": "Sequential (SEQUENTIALLY) or non-sequential (NON_SEQUENTIALLY)",
"nullable": false,
"example": "SEQUENTIALLY",
"deprecated": false,
"enum": [
"NON_SEQUENTIALLY",
"SEQUENTIALLY"
]
},
"WebhookConfigSaveRequestWebhookEvent": {
"type": "string",
"description": "List of events this Webhook will observe",
"nullable": false,
"example": [
"PAYMENT_RECEIVED",
"PAYMENT_CONFIRMED"
],
"deprecated": false,
"enum": [
"PAYMENT_AUTHORIZED",
"PAYMENT_AWAITING_RISK_ANALYSIS",
"PAYMENT_APPROVED_BY_RISK_ANALYSIS",
"PAYMENT_REPROVED_BY_RISK_ANALYSIS",
"PAYMENT_CREATED",
"PAYMENT_UPDATED",
"PAYMENT_CONFIRMED",
"PAYMENT_RECEIVED",
"PAYMENT_ANTICIPATED",
"PAYMENT_OVERDUE",
"PAYMENT_DELETED",
"PAYMENT_RESTORED",
"PAYMENT_REFUNDED",
"PAYMENT_REFUND_IN_PROGRESS",
"PAYMENT_REFUND_DENIED",
"PAYMENT_RECEIVED_IN_CASH_UNDONE",
"PAYMENT_CHARGEBACK_REQUESTED",
"PAYMENT_CHARGEBACK_DISPUTE",
"PAYMENT_AWAITING_CHARGEBACK_REVERSAL",
"PAYMENT_DUNNING_RECEIVED",
"PAYMENT_DUNNING_REQUESTED",
"PAYMENT_BANK_SLIP_CANCELLED",
"PAYMENT_BANK_SLIP_VIEWED",
"PAYMENT_CHECKOUT_VIEWED",
"PAYMENT_CREDIT_CARD_CAPTURE_REFUSED",
"PAYMENT_PARTIALLY_REFUNDED",
"PAYMENT_SPLIT_CANCELLED",
"PAYMENT_SPLIT_DIVERGENCE_BLOCK",
"PAYMENT_SPLIT_DIVERGENCE_BLOCK_FINISHED",
"PAYMENT_SPLIT_DONE",
"INVOICE_CREATED",
"INVOICE_UPDATED",
"INVOICE_SYNCHRONIZED",
"INVOICE_AUTHORIZED",
"INVOICE_PROCESSING_CANCELLATION",
"INVOICE_CANCELED",
"INVOICE_CANCELLATION_DENIED",
"INVOICE_ERROR",
"TRANSFER_CREATED",
"TRANSFER_PENDING",
"TRANSFER_IN_BANK_PROCESSING",
"TRANSFER_BLOCKED",
"TRANSFER_DONE",
"TRANSFER_FAILED",
"TRANSFER_CANCELLED",
"BILL_CREATED",
"BILL_PENDING",
"BILL_BANK_PROCESSING",
"BILL_PAID",
"BILL_CANCELLED",
"BILL_FAILED",
"BILL_REFUNDED",
"RECEIVABLE_ANTICIPATION_CANCELLED",
"RECEIVABLE_ANTICIPATION_SCHEDULED",
"RECEIVABLE_ANTICIPATION_PENDING",
"RECEIVABLE_ANTICIPATION_CREDITED",
"RECEIVABLE_ANTICIPATION_DEBITED",
"RECEIVABLE_ANTICIPATION_DENIED",
"RECEIVABLE_ANTICIPATION_OVERDUE",
"MOBILE_PHONE_RECHARGE_PENDING",
"MOBILE_PHONE_RECHARGE_CANCELLED",
"MOBILE_PHONE_RECHARGE_CONFIRMED",
"MOBILE_PHONE_RECHARGE_REFUNDED",
"ACCOUNT_STATUS_BANK_ACCOUNT_INFO_APPROVED",
"ACCOUNT_STATUS_BANK_ACCOUNT_INFO_AWAITING_APPROVAL",
"ACCOUNT_STATUS_BANK_ACCOUNT_INFO_PENDING",
"ACCOUNT_STATUS_BANK_ACCOUNT_INFO_REJECTED",
"ACCOUNT_STATUS_COMMERCIAL_INFO_APPROVED",
"ACCOUNT_STATUS_COMMERCIAL_INFO_AWAITING_APPROVAL",
"ACCOUNT_STATUS_COMMERCIAL_INFO_EXPIRED",
"ACCOUNT_STATUS_COMMERCIAL_INFO_EXPIRING_SOON",
"ACCOUNT_STATUS_COMMERCIAL_INFO_PENDING",
"ACCOUNT_STATUS_COMMERCIAL_INFO_REJECTED",
"ACCOUNT_STATUS_DOCUMENT_APPROVED",
"ACCOUNT_STATUS_DOCUMENT_AWAITING_APPROVAL",
"ACCOUNT_STATUS_DOCUMENT_PENDING",
"ACCOUNT_STATUS_DOCUMENT_REJECTED",
"ACCOUNT_STATUS_GENERAL_APPROVAL_APPROVED",
"ACCOUNT_STATUS_GENERAL_APPROVAL_AWAITING_APPROVAL",
"ACCOUNT_STATUS_GENERAL_APPROVAL_PENDING",
"ACCOUNT_STATUS_GENERAL_APPROVAL_REJECTED",
"SUBSCRIPTION_CREATED",
"SUBSCRIPTION_UPDATED",
"SUBSCRIPTION_INACTIVATED",
"SUBSCRIPTION_DELETED",
"SUBSCRIPTION_SPLIT_DISABLED",
"SUBSCRIPTION_SPLIT_DIVERGENCE_BLOCK",
"SUBSCRIPTION_SPLIT_DIVERGENCE_BLOCK_FINISHED",
"CHECKOUT_CREATED",
"CHECKOUT_CANCELED",
"CHECKOUT_EXPIRED",
"CHECKOUT_PAID",
"BALANCE_VALUE_BLOCKED",
"BALANCE_VALUE_UNBLOCKED",
"INTERNAL_TRANSFER_CREDIT",
"INTERNAL_TRANSFER_DEBIT",
"ACCESS_TOKEN_CREATED",
"ACCESS_TOKEN_DELETED",
"ACCESS_TOKEN_DISABLED",
"ACCESS_TOKEN_ENABLED",
"ACCESS_TOKEN_EXPIRED",
"ACCESS_TOKEN_EXPIRING_SOON",
"PIX_AUTOMATIC_RECURRING_AUTHORIZATION_CREATED",
"PIX_AUTOMATIC_RECURRING_AUTHORIZATION_ACTIVATED",
"PIX_AUTOMATIC_RECURRING_AUTHORIZATION_CANCELLED",
"PIX_AUTOMATIC_RECURRING_AUTHORIZATION_EXPIRED",
"PIX_AUTOMATIC_RECURRING_AUTHORIZATION_REFUSED",
"PIX_AUTOMATIC_RECURRING_PAYMENT_INSTRUCTION_CREATED",
"PIX_AUTOMATIC_RECURRING_PAYMENT_INSTRUCTION_SCHEDULED",
"PIX_AUTOMATIC_RECURRING_PAYMENT_INSTRUCTION_REFUSED",
"PIX_AUTOMATIC_RECURRING_PAYMENT_INSTRUCTION_CANCELLED",
"PIX_AUTOMATIC_RECURRING_ELIGIBILITY_UPDATED"
]
},
"WebhookConfigGetResponseDTO": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "Unique Webhook Identifier",
"example": "bbf67496-1379-4b6d-a348-fd5fa229f1c",
"deprecated": false
},
"name": {
"type": "string",
"description": "Webhook name",
"example": "Name Example",
"deprecated": false
},
"url": {
"type": "string",
"description": "Webhook URL",
"example": "https://www.example.com/webhook/asaas",
"deprecated": false
},
"email": {
"type": "string",
"description": "Email that will receive notifications about the Webhook",
"example": "john.doe@asaas.com.br",
"deprecated": false
},
"enabled": {
"type": "boolean",
"description": "Set whether the Webhook is active",
"example": true,
"deprecated": false
},
"interrupted": {
"type": "boolean",
"description": "Set whether the sync queue is stopped",
"example": false,
"deprecated": false
},
"apiVersion": {
"type": "integer",
"description": "API Version",
"format": "int32",
"example": 3,
"deprecated": false
},
"hasAuthToken": {
"type": "boolean",
"description": "Indicates whether an authentication token is registered for the webhook",
"example": true,
"deprecated": false
},
"sendType": {
"$ref": "#/components/schemas/WebhookConfigGetResponseWebhookSendType"
},
"penalizedRequestsCount": {
"type": "integer",
"description": "Number of penalized requests",
"format": "int32",
"example": 0,
"deprecated": false
},
"events": {
"type": "array",
"description": "List of events this Webhook will observe",
"example": [
"PAYMENT_RECEIVED",
"PAYMENT_CONFIRMED"
],
"deprecated": false,
"items": {
"$ref": "#/components/schemas/WebhookConfigGetResponseWebhookEvent"
},
"enum": [
"PAYMENT_AUTHORIZED",
"PAYMENT_AWAITING_RISK_ANALYSIS",
"PAYMENT_APPROVED_BY_RISK_ANALYSIS",
"PAYMENT_REPROVED_BY_RISK_ANALYSIS",
"PAYMENT_CREATED",
"PAYMENT_UPDATED",
"PAYMENT_CONFIRMED",
"PAYMENT_RECEIVED",
"PAYMENT_ANTICIPATED",
"PAYMENT_OVERDUE",
"PAYMENT_DELETED",
"PAYMENT_RESTORED",
"PAYMENT_REFUNDED",
"PAYMENT_REFUND_IN_PROGRESS",
"PAYMENT_REFUND_DENIED",
"PAYMENT_RECEIVED_IN_CASH_UNDONE",
"PAYMENT_CHARGEBACK_REQUESTED",
"PAYMENT_CHARGEBACK_DISPUTE",
"PAYMENT_AWAITING_CHARGEBACK_REVERSAL",
"PAYMENT_DUNNING_RECEIVED",
"PAYMENT_DUNNING_REQUESTED",
"PAYMENT_BANK_SLIP_CANCELLED",
"PAYMENT_BANK_SLIP_VIEWED",
"PAYMENT_CHECKOUT_VIEWED",
"PAYMENT_CREDIT_CARD_CAPTURE_REFUSED",
"PAYMENT_PARTIALLY_REFUNDED",
"PAYMENT_SPLIT_CANCELLED",
"PAYMENT_SPLIT_DIVERGENCE_BLOCK",
"PAYMENT_SPLIT_DIVERGENCE_BLOCK_FINISHED",
"PAYMENT_SPLIT_DONE",
"INVOICE_CREATED",
"INVOICE_UPDATED",
"INVOICE_SYNCHRONIZED",
"INVOICE_AUTHORIZED",
"INVOICE_PROCESSING_CANCELLATION",
"INVOICE_CANCELED",
"INVOICE_CANCELLATION_DENIED",
"INVOICE_ERROR",
"TRANSFER_CREATED",
"TRANSFER_PENDING",
"TRANSFER_IN_BANK_PROCESSING",
"TRANSFER_BLOCKED",
"TRANSFER_DONE",
"TRANSFER_FAILED",
"TRANSFER_CANCELLED",
"BILL_CREATED",
"BILL_PENDING",
"BILL_BANK_PROCESSING",
"BILL_PAID",
"BILL_CANCELLED",
"BILL_FAILED",
"BILL_REFUNDED",
"RECEIVABLE_ANTICIPATION_CANCELLED",
"RECEIVABLE_ANTICIPATION_SCHEDULED",
"RECEIVABLE_ANTICIPATION_PENDING",
"RECEIVABLE_ANTICIPATION_CREDITED",
"RECEIVABLE_ANTICIPATION_DEBITED",
"RECEIVABLE_ANTICIPATION_DENIED",
"RECEIVABLE_ANTICIPATION_OVERDUE",
"MOBILE_PHONE_RECHARGE_PENDING",
"MOBILE_PHONE_RECHARGE_CANCELLED",
"MOBILE_PHONE_RECHARGE_CONFIRMED",
"MOBILE_PHONE_RECHARGE_REFUNDED",
"ACCOUNT_STATUS_BANK_ACCOUNT_INFO_APPROVED",
"ACCOUNT_STATUS_BANK_ACCOUNT_INFO_AWAITING_APPROVAL",
"ACCOUNT_STATUS_BANK_ACCOUNT_INFO_PENDING",
"ACCOUNT_STATUS_BANK_ACCOUNT_INFO_REJECTED",
"ACCOUNT_STATUS_COMMERCIAL_INFO_APPROVED",
"ACCOUNT_STATUS_COMMERCIAL_INFO_AWAITING_APPROVAL",
"ACCOUNT_STATUS_COMMERCIAL_INFO_EXPIRED",
"ACCOUNT_STATUS_COMMERCIAL_INFO_EXPIRING_SOON",
"ACCOUNT_STATUS_COMMERCIAL_INFO_PENDING",
"ACCOUNT_STATUS_COMMERCIAL_INFO_REJECTED",
"ACCOUNT_STATUS_DOCUMENT_APPROVED",
"ACCOUNT_STATUS_DOCUMENT_AWAITING_APPROVAL",
"ACCOUNT_STATUS_DOCUMENT_PENDING",
"ACCOUNT_STATUS_DOCUMENT_REJECTED",
"ACCOUNT_STATUS_GENERAL_APPROVAL_APPROVED",
"ACCOUNT_STATUS_GENERAL_APPROVAL_AWAITING_APPROVAL",
"ACCOUNT_STATUS_GENERAL_APPROVAL_PENDING",
"ACCOUNT_STATUS_GENERAL_APPROVAL_REJECTED",
"SUBSCRIPTION_CREATED",
"SUBSCRIPTION_UPDATED",
"SUBSCRIPTION_INACTIVATED",
"SUBSCRIPTION_DELETED",
"SUBSCRIPTION_SPLIT_DISABLED",
"SUBSCRIPTION_SPLIT_DIVERGENCE_BLOCK",
"SUBSCRIPTION_SPLIT_DIVERGENCE_BLOCK_FINISHED",
"CHECKOUT_CREATED",
"CHECKOUT_CANCELED",
"CHECKOUT_EXPIRED",
"CHECKOUT_PAID",
"BALANCE_VALUE_BLOCKED",
"BALANCE_VALUE_UNBLOCKED",
"INTERNAL_TRANSFER_CREDIT",
"INTERNAL_TRANSFER_DEBIT",
"ACCESS_TOKEN_CREATED",
"ACCESS_TOKEN_DELETED",
"ACCESS_TOKEN_DISABLED",
"ACCESS_TOKEN_ENABLED",
"ACCESS_TOKEN_EXPIRED",
"ACCESS_TOKEN_EXPIRING_SOON",
"PIX_AUTOMATIC_RECURRING_AUTHORIZATION_CREATED",
"PIX_AUTOMATIC_RECURRING_AUTHORIZATION_ACTIVATED",
"PIX_AUTOMATIC_RECURRING_AUTHORIZATION_CANCELLED",
"PIX_AUTOMATIC_RECURRING_AUTHORIZATION_EXPIRED",
"PIX_AUTOMATIC_RECURRING_AUTHORIZATION_REFUSED",
"PIX_AUTOMATIC_RECURRING_PAYMENT_INSTRUCTION_CREATED",
"PIX_AUTOMATIC_RECURRING_PAYMENT_INSTRUCTION_SCHEDULED",
"PIX_AUTOMATIC_RECURRING_PAYMENT_INSTRUCTION_REFUSED",
"PIX_AUTOMATIC_RECURRING_PAYMENT_INSTRUCTION_CANCELLED",
"PIX_AUTOMATIC_RECURRING_ELIGIBILITY_UPDATED"
]
}
}
},
"WebhookConfigGetResponseWebhookSendType": {
"type": "string",
"description": "Sequential (SEQUENTIALLY) or non-sequential (NON_SEQUENTIALLY)",
"example": "SEQUENTIALLY",
"deprecated": false,
"enum": [
"NON_SEQUENTIALLY",
"SEQUENTIALLY"
]
},
"WebhookConfigGetResponseWebhookEvent": {
"type": "string",
"description": "List of events this Webhook will observe",
"example": [
"PAYMENT_RECEIVED",
"PAYMENT_CONFIRMED"
],
"deprecated": false,
"enum": [
"PAYMENT_AUTHORIZED",
"PAYMENT_AWAITING_RISK_ANALYSIS",
"PAYMENT_APPROVED_BY_RISK_ANALYSIS",
"PAYMENT_REPROVED_BY_RISK_ANALYSIS",
"PAYMENT_CREATED",
"PAYMENT_UPDATED",
"PAYMENT_CONFIRMED",
"PAYMENT_RECEIVED",
"PAYMENT_ANTICIPATED",
"PAYMENT_OVERDUE",
"PAYMENT_DELETED",
"PAYMENT_RESTORED",
"PAYMENT_REFUNDED",
"PAYMENT_REFUND_IN_PROGRESS",
"PAYMENT_REFUND_DENIED",
"PAYMENT_RECEIVED_IN_CASH_UNDONE",
"PAYMENT_CHARGEBACK_REQUESTED",
"PAYMENT_CHARGEBACK_DISPUTE",
"PAYMENT_AWAITING_CHARGEBACK_REVERSAL",
"PAYMENT_DUNNING_RECEIVED",
"PAYMENT_DUNNING_REQUESTED",
"PAYMENT_BANK_SLIP_CANCELLED",
"PAYMENT_BANK_SLIP_VIEWED",
"PAYMENT_CHECKOUT_VIEWED",
"PAYMENT_CREDIT_CARD_CAPTURE_REFUSED",
"PAYMENT_PARTIALLY_REFUNDED",
"PAYMENT_SPLIT_CANCELLED",
"PAYMENT_SPLIT_DIVERGENCE_BLOCK",
"PAYMENT_SPLIT_DIVERGENCE_BLOCK_FINISHED",
"PAYMENT_SPLIT_DONE",
"INVOICE_CREATED",
"INVOICE_UPDATED",
"INVOICE_SYNCHRONIZED",
"INVOICE_AUTHORIZED",
"INVOICE_PROCESSING_CANCELLATION",
"INVOICE_CANCELED",
"INVOICE_CANCELLATION_DENIED",
"INVOICE_ERROR",
"TRANSFER_CREATED",
"TRANSFER_PENDING",
"TRANSFER_IN_BANK_PROCESSING",
"TRANSFER_BLOCKED",
"TRANSFER_DONE",
"TRANSFER_FAILED",
"TRANSFER_CANCELLED",
"BILL_CREATED",
"BILL_PENDING",
"BILL_BANK_PROCESSING",
"BILL_PAID",
"BILL_CANCELLED",
"BILL_FAILED",
"BILL_REFUNDED",
"RECEIVABLE_ANTICIPATION_CANCELLED",
"RECEIVABLE_ANTICIPATION_SCHEDULED",
"RECEIVABLE_ANTICIPATION_PENDING",
"RECEIVABLE_ANTICIPATION_CREDITED",
"RECEIVABLE_ANTICIPATION_DEBITED",
"RECEIVABLE_ANTICIPATION_DENIED",
"RECEIVABLE_ANTICIPATION_OVERDUE",
"MOBILE_PHONE_RECHARGE_PENDING",
"MOBILE_PHONE_RECHARGE_CANCELLED",
"MOBILE_PHONE_RECHARGE_CONFIRMED",
"MOBILE_PHONE_RECHARGE_REFUNDED",
"ACCOUNT_STATUS_BANK_ACCOUNT_INFO_APPROVED",
"ACCOUNT_STATUS_BANK_ACCOUNT_INFO_AWAITING_APPROVAL",
"ACCOUNT_STATUS_BANK_ACCOUNT_INFO_PENDING",
"ACCOUNT_STATUS_BANK_ACCOUNT_INFO_REJECTED",
"ACCOUNT_STATUS_COMMERCIAL_INFO_APPROVED",
"ACCOUNT_STATUS_COMMERCIAL_INFO_AWAITING_APPROVAL",
"ACCOUNT_STATUS_COMMERCIAL_INFO_EXPIRED",
"ACCOUNT_STATUS_COMMERCIAL_INFO_EXPIRING_SOON",
"ACCOUNT_STATUS_COMMERCIAL_INFO_PENDING",
"ACCOUNT_STATUS_COMMERCIAL_INFO_REJECTED",
"ACCOUNT_STATUS_DOCUMENT_APPROVED",
"ACCOUNT_STATUS_DOCUMENT_AWAITING_APPROVAL",
"ACCOUNT_STATUS_DOCUMENT_PENDING",
"ACCOUNT_STATUS_DOCUMENT_REJECTED",
"ACCOUNT_STATUS_GENERAL_APPROVAL_APPROVED",
"ACCOUNT_STATUS_GENERAL_APPROVAL_AWAITING_APPROVAL",
"ACCOUNT_STATUS_GENERAL_APPROVAL_PENDING",
"ACCOUNT_STATUS_GENERAL_APPROVAL_REJECTED",
"SUBSCRIPTION_CREATED",
"SUBSCRIPTION_UPDATED",
"SUBSCRIPTION_INACTIVATED",
"SUBSCRIPTION_DELETED",
"SUBSCRIPTION_SPLIT_DISABLED",
"SUBSCRIPTION_SPLIT_DIVERGENCE_BLOCK",
"SUBSCRIPTION_SPLIT_DIVERGENCE_BLOCK_FINISHED",
"CHECKOUT_CREATED",
"CHECKOUT_CANCELED",
"CHECKOUT_EXPIRED",
"CHECKOUT_PAID",
"BALANCE_VALUE_BLOCKED",
"BALANCE_VALUE_UNBLOCKED",
"INTERNAL_TRANSFER_CREDIT",
"INTERNAL_TRANSFER_DEBIT",
"ACCESS_TOKEN_CREATED",
"ACCESS_TOKEN_DELETED",
"ACCESS_TOKEN_DISABLED",
"ACCESS_TOKEN_ENABLED",
"ACCESS_TOKEN_EXPIRED",
"ACCESS_TOKEN_EXPIRING_SOON",
"PIX_AUTOMATIC_RECURRING_AUTHORIZATION_CREATED",
"PIX_AUTOMATIC_RECURRING_AUTHORIZATION_ACTIVATED",
"PIX_AUTOMATIC_RECURRING_AUTHORIZATION_CANCELLED",
"PIX_AUTOMATIC_RECURRING_AUTHORIZATION_EXPIRED",
"PIX_AUTOMATIC_RECURRING_AUTHORIZATION_REFUSED",
"PIX_AUTOMATIC_RECURRING_PAYMENT_INSTRUCTION_CREATED",
"PIX_AUTOMATIC_RECURRING_PAYMENT_INSTRUCTION_SCHEDULED",
"PIX_AUTOMATIC_RECURRING_PAYMENT_INSTRUCTION_REFUSED",
"PIX_AUTOMATIC_RECURRING_PAYMENT_INSTRUCTION_CANCELLED",
"PIX_AUTOMATIC_RECURRING_ELIGIBILITY_UPDATED"
]
}
},
"securitySchemes": {
"Authorization": {
"type": "apiKey",
"name": "access_token",
"in": "header"
}
}
},
"x-readme": {
"headers": [
{
"key": "User-Agent",
"value": "NomeDaSuaAplicacao/1.0.0"
}
]
}
}
```
# Sibling pages
* [List Webhooks](https://docs.asaas.com/reference/list-webhooks.md)
* [Retrieve a single Webhook](https://docs.asaas.com/reference/retrieve-a-single-webhook.md)
* [Update Existing Webhook](https://docs.asaas.com/reference/update-existing-webhook.md)
* [Remove Webhook](https://docs.asaas.com/reference/remove-webhook.md)
* [Remove webhook backoff](https://docs.asaas.com/reference/remove-webhook-backoff.md)