Automation Webhook Payload
updated 2 weeks ago
Automations can trigger webhooks as part of the automation stage. The payload of these webhooks includes the user ID, the automation ID, custom user attributes, and properties of the event that triggered the automation.
A POST request is sent to the webhook URL with a JSON payload. The payload structure is as follows:
{
"uid": "user ID",
"automation_id": "ID of the triggering automation",
"meta": {
"custom_user_attributes": "value"
},
"event": {
"triggering_event_properties": "value"
}
}
The meta
object will contain any custom user attributes in the user profile. The event
object will contain any properties of the event that triggered the automation.
Here is an example payload for a webhook triggered for a user with ID 12345
by a successful Stripe payment automation with ID 68e6815aba501a458b560f4e
.
{
"uid": "12345",
"automation_id": "68e6815aba501a458b560f4e",
"meta": {
"stripe_id": "cus_L6QsU59aEtzk2C",
"stripe_delinquent": 1
},
"event": {
"id": "in_5SFHhUCMAkknks8S7nUj1dDu",
"currency": "USD",
"currency_symbol": "$",
"invoice_url": "https://invoice.stripe.com/i/acct_~/live_YWN~?s=ap",
"invoice_pdf": "https://pay.stripe.com/invoice/acct_~/live_YWN~/pdf?s=ap",
"account_name": "Awesome Co.",
"account_country": "US",
"total": 20,
"subtotal": 20,
"amount_due": 20,
"invoice_number": "4CB21EE9-0045",
"billing_reason": "subscription_cycle",
"subscription": "sub_1KQE68CMAkknks8S5j71DAwY",
"subscription_start": "2025-10-06T16:55:14.000Z",
"subscription_end": "2025-11-06T16:55:14.000Z",
"charge": "ch_4SFIf0CMAkknks8S0N7YnczI"
}
}
Was this article helpful?