Webhook Setup & Handling
What is this
Webhooks allow your application to receive real-time notifications whenever certain events occur on our platform. For example, a status update. Instead of constantly polling our API to check for updates, we push the information to your system automatically via a callback URL you configure.
Creating a webhook
To create a webhook, you'll need to provide a role and your correspondentId. Once configured, the URL you register will be triggered according to the role’s activity.
If you're using the Simple WhiteLabel solution, webhook setup is available directly through the Frente Administration Panel.
Permited Roles
transactions
This role subject is paper money transactions created through the Simple API. It allows you to receive information update about the subject
String
yes
remittances
This role subject is remittance transactions created through the Simple API. It allows you to receive information update about the subject
String
yes
clients
This role subject is client profiles created through the Simple API. It allows you to receive information update about the subject
String
yes
simple_transactions
This role subject is paper money transactions created through the Simple WhiteLabel. It allows you to receive information update about the subject
String
yes
simple_remittances
This role subject is remittance transactions created through the Simple WhiteLabel. It allows you to receive information update about the subject.
String
yes
simple_moneygram
This role subject is MoneyGram transactions created through the Simple White Label. It allows you to receive information update about the subject.
String
yes
Webhook notification data
Notification via webhook will be sent with the following data in the body of the request:
Field
Description
id
Transaction/Customer identifier
correspondentId
Correspondent identifier
status
Transaction status
clientId
Customer identifier (transaction notification only)
createdAt
Transaction/Customer create date
updatedAt
Transaction/Customer update date