On this page, you'll find information about:
- The general webhook structure.
- The types of webhooks.
Webhook structure
In general, the body of a webhook contains the following objects.
| Parameter | Data type | Description |
|---|---|---|
data |
Object | Object that contains information about the event. The information contained in this object varies and depends on the webhook type. |
environment |
String | The environment where the transaction was processed—test or live. |
type |
String | The webhook type. |
Below is an example request body for a webhook of type legalEntity.created.
Webhook types
Webhooks are typically sent when:
- A resource was created or updated.
- The verification status changed.
| Type | Description |
|---|---|
| legalEntity.created | A legal entity was successfully created. |
| legalEntity.updated | There was a change in the legal entity. For example, you updated their data, the verification status changed, or you disabled their capability. |