Webhooks
Learn how to start using webhooks notifications.
Webhooks are notifications about API events, sent as they occur. You can configure webhook endpoints via the API to be notified about events that happen in your account or connected accounts.

The Webhook object

Attributes

Body
Headers
Property
Type
Description
uuid
String
Webhook unique identifier (autogenerated).
name
String
Webhook name.
description
String
Webhook description.
events
String
List of available events (for subscriber all events, send only ALL string).
url
String
Webhook endpoint URL.
is_active
Boolean
Webhook enabled or disabled.
Property
Type
Description
auth
String
Two types of Authentication header:
  • Basic: requires basic_username and basic_password. This header will be sent as Basic bas64(basic_username:basic_password)
  • Secret-key: only requires the secret key string. This header will be sent as Bearer secret_key
custom
String
Other constants headers that your endpoint requires.

Example Object

Webhook Object
1
{
2
"uuid": "ISGW-4-585a16b094d64ae99d019caf27795536",
3
"name": "webhook_1",
4
"description": "My webhook #1",
5
"events": [
6
"TRANSACTION_EVENT"
7
],
8
"headers": {
9
"auth": {
10
"basic_username": "my_user",
11
"basic_password": "my_pass",
12
"secret_key": "my_secret_key"
13
},
14
"custom": {
15
"header_key_1": "value_1",
16
"header_key_2": "value_2"
17
}
18
},
19
"url": "http://merchant-host.com/callback",
20
"is_active": true
21
}
Copied!
post
https://issuing-api.dlocal.com/
issuing/webhooks
Create notifications
The headers only are shown when you create this webhook. You don't have to modify the headers later.

Example Request

1
{
2
"name": "webhook_1",
3
"description": "My webhook #1",
4
"url": "http://merchant-host.com/callback",
5
"events": [
6
"TRANSACTION_EVENT"
7
],
8
"headers": {
9
"custom": {
10
"header_key_1": "value_1"
11
}
12
},
13
"is_active": false
14
}
Copied!
put
https://issuing-api.dlocal.com/
issuing/webhooks/{webhook_uuid}
Update webhooks
All of the fields will be updated.

Example Request

1
{
2
"name": "webhook_1",
3
"description": "My webhook #1 - modified",
4
"url": "http://merchant-host.com/callback",
5
"events": [
6
"ALL"
7
],
8
"is_active": true
9
}
Copied!
get
https://issuing-api.dlocal.com/
issuing/webhooks/{webhook_uuid}
Retrieve a notification
get
https://issuing-api.dlocal.com/
issuing/webhooks
List all the notifications
delete
https://issuing-api.dlocal.com/
issuing/webhooks/{webhook_uuid}
Delete webhooks
Last modified 23d ago