Webhooks
You can use Webhooks to update your servers on events related to your contact lists in almost real-time.
The Webhooks to your contact list will POST to the URL which you provide with the updated data. You can select the events on the contact list to trigger your webhook.
If you are new to this concept, we recommend PBWiki Webhooks page for your reference.
Getting Started
- Log in to your Benchmarkemail account
- Click on the Lists Tab
- Click on the name of the list you want to configure
- Click on the Webhooks link from the Contact List Activities option
Setting up the Webhook
- Provide a valid URL to post the data to for the event
- Select the events to trigger the webhook
- Click on Add WebHook button to save the changes
Once you have added a webhook, you can then add a new webhook or update / delete the existing webhooks.
Supported Events
Benchmark Email allows you to trigger your webhooks for the following events:
POSTed data
Once the event you have selected is triggered, the webhook will send the data related to the evented in a HTTP POST to the URL you have specified.
The data is posted as key / value pairs.
Below is listed the data for the above events.
Subscribes
| Key | Value (sample) | |
| type | subscribe | Type of the Trigger |
| fired_at | 11/9/2011 12:42:35 PM | Time of the event |
| list_id | 999 | The List ID (refer to the API) |
| email | test@benchmarkemail.com | Email address which was subscribed |
| optin | | 1 - If the email was opted in |
| optin_ip | | The IP of the opt in email |
| optin_date | | The subscription date for the opt in email |
| First_Name | Peter | First name (contact attribute) |
| Last_Name | Parker | Last name (contact attribute) |
| Last_Name | Parker | Last name (contact attribute) |
| Middle_Name | | contact attribute |
| Job_Title | | contact attribute |
| Company_Name | | contact attribute |
| Address | | contact attribute |
| City | | contact attribute |
| State | | contact attribute |
| Zip | | contact attribute |
| Country | | contact attribute |
| Cell_Phone | | contact attribute |
| Phone | | contact attribute |
| Fax | | contact attribute |
| Notes | | contact attribute |
| Business_Address | | contact attribute |
| Business_City | | contact attribute |
| Business_State | | contact attribute |
| Business_Zip | | contact attribute |
| Business_Country | | contact attribute |
| Business_Phone | | contact attribute |
| Business_Fax | | contact attribute |
| Extra_1 | | contact attribute |
| Extra_2 | | contact attribute |
| Extra_3 | | contact attribute |
| Extra_4 | | contact attribute |
| Extra_5 | | contact attribute |
| Extra_6 | | contact attribute |
Unsubscribes
| Key | Value (sample) | |
| type | unsubscribe | Type of the Trigger |
| fired_at | 11/9/2011 12:42:35 PM | Time of the event |
| list_id | 999 | The List ID (refer to the API) |
| email | test@benchmarkemail.com | Email address which was subscribed |
| action | unsub | |
| reason | manual | |
| optin | | 1 - If the email was opted in |
| optin_ip | | The IP of the opt in email |
| optin_date | | The subscription date for the opt in email |
| First_Name | Peter | First name (contact attribute) |
| Last_Name | Parker | Last name (contact attribute) |
| Last_Name | Parker | Last name (contact attribute) |
| Middle_Name | | contact attribute |
| Job_Title | | contact attribute |
| Company_Name | | contact attribute |
| Address | | contact attribute |
| City | | contact attribute |
| State | | contact attribute |
| Zip | | contact attribute |
| Country | | contact attribute |
| Cell_Phone | | contact attribute |
| Phone | | contact attribute |
| Fax | | contact attribute |
| Notes | | contact attribute |
| Business_Address | | contact attribute |
| Business_City | | contact attribute |
| Business_State | | contact attribute |
| Business_Zip | | contact attribute |
| Business_Country | | contact attribute |
| Business_Phone | | contact attribute |
| Business_Fax | | contact attribute |
| Extra_1 | | contact attribute |
| Extra_2 | | contact attribute |
| Extra_3 | | contact attribute |
| Extra_4 | | contact attribute |
| Extra_5 | | contact attribute |
| Extra_6 | | contact attribute |
Changes to the profile
| Key | Value (sample) | |
| type | profile | Type of the Trigger |
| fired_at | 11/9/2011 12:42:35 PM | Time of the event |
| list_id | 999 | The List ID (refer to the API) |
| email | test@benchmarkemail.com | Email address of the updated record |
| optin | | 1 - If the email was opted in |
| optin_ip | | The IP of the opt in email |
| optin_date | | The subscription date for the opt in email |
| First_Name | Peter | First name (contact attribute) |
| Last_Name | Parker | Last name (contact attribute) |
| Last_Name | Parker | Last name (contact attribute) |
| Middle_Name | | contact attribute |
| Job_Title | | contact attribute |
| Company_Name | | contact attribute |
| Address | | contact attribute |
| City | | contact attribute |
| State | | contact attribute |
| Zip | | contact attribute |
| Country | | contact attribute |
| Cell_Phone | | contact attribute |
| Phone | | contact attribute |
| Fax | | contact attribute |
| Notes | | contact attribute |
| Business_Address | | contact attribute |
| Business_City | | contact attribute |
| Business_State | | contact attribute |
| Business_Zip | | contact attribute |
| Business_Country | | contact attribute |
| Business_Phone | | contact attribute |
| Business_Fax | | contact attribute |
| Extra_1 | | contact attribute |
| Extra_2 | | contact attribute |
| Extra_3 | | contact attribute |
| Extra_4 | | contact attribute |
| Extra_5 | | contact attribute |
| Extra_6 | | contact attribute |
Cleaning of the email
| Key | Value (sample) | |
| type | cleaned | Type of the Trigger |
| fired_at | 11/9/2011 12:42:35 PM | Time of the event |
| list_id | 999 | The List ID (refer to the API) |
| email | cleaned | |
| reason | | |
Change of the existing email address
| Key | Value (sample) | |
| type | upemail | Type of the Trigger |
| fired_at | 11/9/2011 12:42:35 PM | Time of the event |
| list_id | 999 | The List ID (refer to the API) |
| old_email | test@benchmarkemail.com | Email address of the record to be updated |
| email | test123@benchmarkemail.com | Updated email address |
| optin | | 1 - If the email was opted in |
| optin_ip | | The IP of the opt in email |
| optin_date | | The subscription date for the opt in email |
| First_Name | Peter | First name (contact attribute) |
| Last_Name | Parker | Last name (contact attribute) |
| Last_Name | Parker | Last name (contact attribute) |
| Middle_Name | | contact attribute |
| Job_Title | | contact attribute |
| Company_Name | | contact attribute |
| Address | | contact attribute |
| City | | contact attribute |
| State | | contact attribute |
| Zip | | contact attribute |
| Country | | contact attribute |
| Cell_Phone | | contact attribute |
| Phone | | contact attribute |
| Fax | | contact attribute |
| Notes | | contact attribute |
| Business_Address | | contact attribute |
| Business_City | | contact attribute |
| Business_State | | contact attribute |
| Business_Zip | | contact attribute |
| Business_Country | | contact attribute |
| Business_Phone | | contact attribute |
| Business_Fax | | contact attribute |
| Extra_1 | | contact attribute |
| Extra_2 | | contact attribute |
| Extra_3 | | contact attribute |
| Extra_4 | | contact attribute |
| Extra_5 | | contact attribute |
| Extra_6 | | contact attribute |