Overview
Webhooks push out real-time notifications to other services when certain events happen. Events include:
- Guide Displayed
- Track Event Received
- NPS Surveys (Displayed / Submitted)
- Polls (Displayed / Submitted)
- more coming soon!
Webhooks allow you to drive your workflows across your business based on real-time events that occur in Pendo. For example, you might want to:
- Send event information to a provider such as Segment.com to then be routed to other systems
- Invoke remote code (like AWS Lambdas or Zapier) to drive workflows
- Enrich other systems of record in real-time with Pendo-specific events (e.g. Zendesk Sunshine platform)
- Send events to third-party SIEM providers for analysis in real-time
- Archiving admin events for auditing and compliance
Requirements
To configure and manage webhooks, Pendo users will need Pendo Administrator Permissions.
Note: Agent Version 2.33.0 or higher is required to use Poll and NPS Events.
Webhook Types & Format
When creating a webhook, admins have the ability to select from a few pre-defined formats:
Segment.com Type
If you use Segment.com integration, you can create Segment.com type webhooks to send events in Segment's preferred format.
Note: You will need to Pendo as a Source in Segment to retrieve a Write Key. Read more about Segment write keys here.
URL Type
Webhooks typically send event information through a URL. If you're using a URL that will accept your Pendo event information, choose this type.
Payload Format
Pendo webhooks use JSON format only.
Managing Webhooks
To setup webhooks, navigate to the "Integrations" section once you click on "Settings" in the main navigation bar.
Then, click on the "Webhooks" tab.
Once you create webhooks(whether it's active or not), you will see your full list in this section.
Create a Webhook
To create one, click on "+ Add Webhook" button.
This will open an overlay where you will be prompted to do the following actions:
- Name your webhook - Be sure to name it something to understand where the information destination will be for future reference.
- Select a type - Segment.com or URL
- Input your write key or URL
For Segment.com Type Webhooks
To use this webhook type, you need to have a segment.com account. You will need to setup Pendo as a Source in Segment to retrieve a Write Key. Once you've setup Pendo as a Source in Segment you'll be able to copy your write key from the Overview > Installation section to use in Pendo to setup your Webhook.
For URL Type Webhooks
Add your desired destination URL. Once an event is triggered, information will be sent to this URL.
Note: Webhook event information may contain personally identifiable information (PII) depending on your installation and data mappings. Be sure to use a destination (or service) that you trust before testing or enabling your webhook.
Use the "Test" button to see a sample payload and ensure that your destination can accept the event payload.
Secret value with URL type
You can also configure a "secret" key with URL type webhooks. "Secret" is used to help validate the event information is from the correct source. Your secret value can be any value (including special characters) you desire so you can configure it as a simple to complex as your security standards require.
Event Category Type
Choose what event categories you would like to receive. Event categories include:
Once you choose your event type, save your webhook configuration.
Active & Inactive States
Once you're ready to turn on your webhook, toggle the webhook to the "Active" state from the list of webhooks.
If you need to stop sending events for a certain webhook at any point in time, toggle it back to the "Inactive" state without deleting the configuration. When you toggle it back to the "Inactive" state, confirm your action:
Edit
To edit an existing webhook, hover over the name in the webhook list to the edit icon.
Click the edit icon to open the webhook overlay. Remember to save your webhook after making changes.
Delete
To delete an existing webhook, hover over the name in the list to reveal the delete icon.
Click the delete icon to delete the webhook overlay, and confirm or cancel the delete in the confirmation.
Once a webhook is deleted events will stop being sent.
Note: If you don't want to lose the configuration, simply toggle the status back to "inactive" instead.
Frequently Asked Questions
If I receive an error, will Pendo try to send the event again?
If Pendo receives a 429 error or an error message from 500 to 599 range, Pendo will retry up to 5 times.
Will I receive events from Excluded visitors?
No, Pendo will not send an event to your destination if a visitor is excluded.
Can I use Slack as a Webhook destination?
No, when using Slack as a Webhook destination it is looking for the POST to be in a specific format. You'll need to use a tool such as Zapier to translate the JSON body that Pendo is sending into a format that Slack expects.