Webhook events for automatic conversion rule creation and execution status changes.
Events
Rule Creation Events
| Event Name | Status | Description |
|---|---|---|
auto_conversion_rule.create | SUCCESS | Rule created successfully |
auto_conversion_rule.create | FAILED | Rule creation failed |
Rule Execution Events
| Event Name | Status | Description |
|---|---|---|
auto_conversion_rule_order.completed | COMPLETED | Full conversion flow completed |
auto_conversion_rule_order.deposit_failed | FAILED | Failed at deposit stage |
auto_conversion_rule_order.conversion_failed | FAILED | Failed at conversion stage |
auto_conversion_rule_order.withdrawal_failed | FAILED | Failed at withdrawal stage |
auto_conversion_rule.create (Success)
Triggered when an auto-conversion rule is successfully created and activated.
Payload
{
"event_name": "auto_conversion_rule.create",
"resource": {
"type": "auto_conversion_rule",
"id": "acr_a1b2c3d4-e5f6-7890-abcd-ef1234567890",
"idempotency_key": "678160c6-ca41-40ee-bfe7-35057ade157d"
},
"data": {
"status": "SUCCESS",
"customer_id": "cus_a1b2c3d4-e5f6-7890-abcd-ef1234567890",
"account_id": "BZ-ABCD-1234",
"auto_conversion_rule_id": "acr_a1b2c3d4-e5f6-7890-abcd-ef1234567890",
"idempotency_key": "my-unique-key-123",
"created_at": "2024-01-22T12:00:00.000Z",
"modified_at": "2024-01-22T12:00:00.000Z"
}
}auto_conversion_rule.create (Failed)
Triggered when an auto-conversion rule creation fails.
Payload
{
"event_name": "auto_conversion_rule.create",
"resource": {
"type": "auto_conversion_rule",
"id": "acr_a1b2c3d4-e5f6-7890-abcd-ef1234567890",
"idempotency_key": "678160c6-ca41-40ee-bfe7-35057ade157d"
},
"data": {
"status": "FAILED",
"customer_id": "cus_a1b2c3d4-e5f6-7890-abcd-ef1234567890",
"account_id": "BZ-ABCD-1234",
"auto_conversion_rule_id": "acr_a1b2c3d4-e5f6-7890-abcd-ef1234567890",
"idempotency_key": "my-unique-key-123",
"created_at": "2024-01-22T12:00:00.000Z",
"modified_at": "2024-01-22T12:00:00.000Z",
"failure_reason": "Invalid source currency"
}
}Fields (Creation Events)
| Field | Type | Description |
|---|---|---|
status | string | SUCCESS or FAILED |
customer_id | string | The customer ID who created the rule |
account_id | string | Account ID of the customer |
auto_conversion_rule_id | string | Unique identifier for the rule |
idempotency_key | string | The idempotency key provided during creation |
created_at | string | ISO 8601 timestamp |
modified_at | string | ISO 8601 timestamp |
failure_reason | string | Only present when status is FAILED |
auto_conversion_rule_order.completed
Triggered when an auto-conversion rule execution completes successfully. This means all stages (deposit → conversion → withdrawal) completed.
Payload
{
"event_name": "auto_conversion_rule_order.completed",
"resource": {
"type": "auto_conversion_rule_order",
"id": "acro_a1b2c3d4-e5f6-7890-abcd-ef1234567890",
"idempotency_key": "678160c6-ca41-40ee-bfe7-35057ade157d"
},
"data": {
"event_name": "AUTO_CONVERSION_RULE",
"status": "COMPLETED",
"customer_id": "cus_a1b2c3d4-e5f6-7890-abcd-ef1234567890",
"account_id": "BZ-ABCD-1234",
"auto_conversion_rule_id": "acr_xyz789",
"order_id": "acro_a1b2c3d4-e5f6-7890-abcd-ef1234567890",
"idempotency_key": "my-unique-key-123",
"created_at": "2024-01-22T12:00:00.000Z",
"modified_at": "2024-01-22T12:05:00.000Z"
}
}auto_conversion_rule_order.deposit_failed
Triggered when an auto-conversion rule execution fails at the deposit stage.
Payload
{
"event_name": "auto_conversion_rule_order.deposit_failed",
"resource": {
"type": "auto_conversion_rule_order",
"id": "acro_a1b2c3d4-e5f6-7890-abcd-ef1234567890",
"idempotency_key": "678160c6-ca41-40ee-bfe7-35057ade157d"
},
"data": {
"event_name": "AUTO_CONVERSION_RULE",
"status": "FAILED",
"customer_id": "cus_a1b2c3d4-e5f6-7890-abcd-ef1234567890",
"account_id": "BZ-ABCD-1234",
"auto_conversion_rule_id": "acr_xyz789",
"order_id": "acro_a1b2c3d4-e5f6-7890-abcd-ef1234567890",
"idempotency_key": "my-unique-key-123",
"created_at": "2024-01-22T12:00:00.000Z",
"modified_at": "2024-01-22T12:01:00.000Z"
}
}auto_conversion_rule_order.conversion_failed
Triggered when an auto-conversion rule execution fails at the conversion stage.
Payload
{
"event_name": "auto_conversion_rule_order.conversion_failed",
"resource": {
"type": "auto_conversion_rule_order",
"id": "acro_a1b2c3d4-e5f6-7890-abcd-ef1234567890",
"idempotency_key": "678160c6-ca41-40ee-bfe7-35057ade157d"
},
"data": {
"event_name": "AUTO_CONVERSION_RULE",
"status": "FAILED",
"customer_id": "cus_a1b2c3d4-e5f6-7890-abcd-ef1234567890",
"account_id": "BZ-ABCD-1234",
"auto_conversion_rule_id": "acr_xyz789",
"order_id": "acro_a1b2c3d4-e5f6-7890-abcd-ef1234567890",
"idempotency_key": "my-unique-key-123",
"created_at": "2024-01-22T12:00:00.000Z",
"modified_at": "2024-01-22T12:02:00.000Z"
}
}auto_conversion_rule_order.withdrawal_failed
Triggered when an auto-conversion rule execution fails at the withdrawal stage.
Payload
{
"event_name": "auto_conversion_rule_order.withdrawal_failed",
"resource": {
"type": "auto_conversion_rule_order",
"id": "acro_a1b2c3d4-e5f6-7890-abcd-ef1234567890",
"idempotency_key": "678160c6-ca41-40ee-bfe7-35057ade157d"
},
"data": {
"event_name": "AUTO_CONVERSION_RULE",
"status": "FAILED",
"customer_id": "cus_a1b2c3d4-e5f6-7890-abcd-ef1234567890",
"account_id": "BZ-ABCD-1234",
"auto_conversion_rule_id": "acr_xyz789",
"order_id": "acro_a1b2c3d4-e5f6-7890-abcd-ef1234567890",
"idempotency_key": "my-unique-key-123",
"created_at": "2024-01-22T12:00:00.000Z",
"modified_at": "2024-01-22T12:03:00.000Z"
}
}Fields (Execution Events)
| Field | Type | Description |
|---|---|---|
event_name | string | Always AUTO_CONVERSION_RULE |
status | string | COMPLETED or FAILED |
customer_id | string | The customer ID who owns the rule |
account_id | string | Account ID of the customer |
auto_conversion_rule_id | string | The rule that triggered this execution |
order_id | string | Unique identifier for this execution |
idempotency_key | string | The idempotency key from rule creation |
created_at | string | ISO 8601 timestamp when execution started |
modified_at | string | ISO 8601 timestamp when execution ended |