Webhook structure and samples for Emails.
{ "events": [ { "id" : {EVENTID}, "email_id" : {EMAILID}, "email" : {EMAIL}, "created_at" : {CREATEDDATE}, "resource_type" : {RESOURCETYPE}, "email_type" : {EMAILTYPE}, "customer_account" : {CUSTOMERACCOUNT}, "auddis" : {AUDDIS}, "status" : {STATUS}, "description" : {DESCRIPTION} } ] }
Webhooks are sent out of SmarterPay Cloud as a JSON array.
The JSON Syntax Rules are:
Property | Variable | Description | Empty Values (1) | Format | Example |
---|---|---|---|---|---|
id | {EVENTID} | The ID of the Webhook Event. | No. | String. | “EV000003432” |
email_id | {EMAILID} | The ID of the Email. | No. | String. | “EM000005332” |
{EMAIL} | The Email address used. | No. | String. | “test@testuser.com” | |
created_at | {CREATEDDATE} | The Date that event was created. | No. | ISO8601. | “2020-12-22T08:05:00.000Z” |
resource_type | {RESOURCETYPE} | The Resource type will be email. | No. | String. | “email” |
email_type | {EMAILTYPE} | Type of email that has been sent out. | No. | String. | “dd_confirmation” |
customer_account | {CUSTOMERACCOUNT} | The Customer Account that the Mandate belongs to, if set. | No. | String. | “CUST00032041” |
auddis | {AUDDIS} | The ID (AUDDIS Reference) of the Mandate. | No. | String. | “REFP01008” |
status | {STATUS} | The Current Status of the Email. | No. | String. | “email_sent” |
description | {DESCRIPTION} | The Description of the event. | No. | String. | “email sent” |
Notes:
(1) Empty Values - The property will always be in the Webhook, however the value of the property may be an empty string (“”).