Overview
Via webhooks, Pinpointe makes it possible to integrate your own application with your Pinpointe email service account when tracking your subscribers' campaign opens and links clicks.
A webhook is an API concept that allows a service (Pinpointe) to provide another application (such as a URL you specify) near-real time information as it is created. For example, if one of your subscribers opens an email, this information is processed at Pinpointe and the webhook then makes a POST request to your specified URL with the "Open" event's details.
Unlike a "traditional" API call that must be initiated by the requester (you), a webhook is essentially always on and will send data whenever the triggering event occurs. Pinpointe currently offers webhooks for two events using our updated Webhook 2.0 feature: Campaign Opens and Link Clicks (within a campaign). Each webhook delivers a JSON-formatted payload to the URL destination you provide.
Implementing Webhooks in Your Pinpointe Account
To use the webhooks, you need to go into Account Settings in your account. To do so, roll your cursor over the small avatar icon at the top left of your account pages and click "Account Settings" (see Fig 1 below):
Fig 1
You will now be on this page (see Fig 2 below):
Fig 2
Click on the menu option - "API + Connectors". It will redirect you to this page (see Fig 3 below):
Fig 3
The default landing page will be for the API feature. Click on the "Webhooks" tab and you will be redirected to this page (see Fig 4 below):
Fig 4
To create a webhook connection, click the blue "Add a Webhook" button. Now select either the "Opens" or "Clicks" option. You will need to provide two pieces of information: some name of your choosing for the webhook you are creating, and the destination URL where you want the webhook payload to be sent.
Click the check box labeled "Enabled" when you are done, and then make sure to click the small disk icon under "Actions" to save your configuration (see Fig 5 below):
Fig 5
"Opens" Webhook Payload
Fig 6 below shows an example of the webhook payload delivered when using the "Opens" webhook:
Parameter Returned Value
| event | open - (in this particular case) |
| userId | Pinpointe User ID of the user who logged into the account and created the webhook |
| userName | Pinpointe User Name of the user who logged into the account and created the webhook |
| time | Timestamp of recorded event |
| ipAddress | |
| subscriberId | The contact's Pinpointe subscriber ID |
| Contact's email address | |
| statType | newsletter - Pinpointe designation for a "normal" newsletter stat identifier |
| sendType | newsletter - Pinpointe designation for a "normal" newsletter send |
| statId | Pinpointe stat ID for that specific campaign send |
| listId | Pinpointe's database numerical identifier for the database the recipient contact is in |
| listName | The name you have given your Pinpointe database |
| newsletterId | Pinpointe numerical identifier for that specific newsletter |
| newsletterName | The name you have given the newsletter (campaign) |
| detail | Pinpointe internal event identifier |
Fig 6
"Clicks" Webhook Payload
Fig 7 below shows an example of the webhook payload delivered when using the "Clicks" webhook:
Parameter Returned Value
| event | click - (in this particular case) |
| userId | Pinpointe User ID of the user who logged into the account and created the webhook |
| userName | Pinpointe User Name of the user who logged into the account and created the webhook |
| time | Timestamp of recorded event |
| ipAddress | |
| subscriberId | The contact's Pinpointe subscriber ID |
| Contact's email address | |
| visitorId | A non-persistent unique identifier of the contact who clicked the link |
| statType | newsletter - Pinpointe designation for a "normal" newsletter stat identifier |
| sendType | newsletter - Pinpointe designation for a "normal" newsletter send |
| statId | Pinpointe stat ID for that specific campaign send |
| listId | Pinpointe's database numerical identifier for the database the recipient contact is in |
| listName | The name you have given your Pinpointe database |
| newsletterId | Pinpointe numerical identifier for that specific newsletter |
| newsletterName | The name you have given the newsletter (campaign) |
| detail -> linkid | Pinpointe link identifier |
| detail -> url | URL of link |
| visitorToken | A non-persistent unique token tied to the visitor ID |
| userAgent |
Fig 7
