DiscordStatus
Referência / Reference

Create new Webhook

post
https://api-sandbox.asaas.com/v3/webhooks

Creates a new Webhook in the authenticated Asaas account to send notifications of the configured events to the URL provided.

Use this operation to provision Webhooks programmatically. Each account can have up to 10 Webhooks.

sendType defines the delivery behavior: SEQUENTIALLY preserves the order of events, while NON_SEQUENTIALLY allows parallel deliveries with no ordering guarantee.

⚠️

Authentication token

If authToken is not provided, Asaas automatically generates a secure token. The generated token is returned only in the creation response and must be stored to validate the notifications you receive.

Related content

Guides

Body Params

Array with desired Webhooks settings

string
required

Webhook name

string
required

Webhook URL

string
required

Email that will receive notifications about the Webhook

boolean
required

Set whether the sync queue is stopped

boolean
required

Set whether the Webhook is active

string
length between 32 and 255

Webhook authentication token

events
array of strings
enum
required

List of events this Webhook will observe

events*
string
enum
required

Sequential (SEQUENTIALLY) or non-sequential (NON_SEQUENTIALLY)

Allowed:
int32

API Version

Responses

Updated 14 days ago

Did this page help you?
Language
Credentials
Header
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated 14 days ago

Did this page help you?