The Merge platform uses webhooks to notify your application when an event occurs in your account. These notifications are sent in near real-time. Webhooks are useful for asynchronous events like receiving funds in your account or when a payout is successfully processed.
These notifications are sent by Merge via HTTPS with a JSON payload. They can then be used to trigger business logic in your backend systems.
The webhook fields that Merge sends in the payload are described below.
id string
The unique identifier (UUID) of the webhook configuration.
Example: 3f546c20-499e-11ed-b878-0242ac120002
created_at date-time
The date and time that the webhook configuration was added to the account.
Example: 2022-10-05T22:36:19.612440+00:00
updated_at date-time
The date and time that the webhook configuration was updated.
Example: 2022-11-05T22:36:19.612440+00:00
url string
The url that is configured to listen to the events.
Example: https://5f07-2401-4900-1f29.test.io
company_id string
The unique indentifier (UUID) of the business.
Example: 5g546c20-499e-11ed-b878-0242ac120002
status enum
The current status of the webhook configuration.
Possible enum values: active
token string
The token value can be used to authenticate the source from where the notification is received.The token value is available in the header of the webhook.
Example: In header look for Authorization value as ABC_123456_qwui