​

Overview

Webhooks can be seen as the key building blocks of applications, allowing systems to exchange data in real-time in response to events. They act as the modern, web-oriented way for servers to receive notifications from other servers. Now, when an event happens on an Extole server, your own application, server, or platform that you integrate with can receive that event via a web request. Our new webhooks functionality allows Extole to send People and Event data directly to the platform or system of your choice , where you’ll be able to record and manage that information and perform actions upon the event’s occurrence. Read about integrating with Segment here. To enable this functionality, please reach out to your CSM, Implementation Manager, or Solutions Architect.

​

The Power of Extole’s Webhooks

Connect Extole with your favorite tools in just a few clicks, and supercharge the value and power of your data. Example use cases and types of Extole webhooks include:

• Shares : Extole will notify your system when a successful advocate share is detected
• Registrations : Extole will notify your system upon a successful registration
• Email Captures : Extole will notify your system when an email capture is detected from a referred friend
• Conversions : Extole will notify your system when a referral conversion event occurs
• Rewards : Extole will notify your system when a reward has been earned

​

Minimal setup

Webhooks require configuration within the Extole platform. You may configure your Extole account to use webhooks by logging in and going to Tech Center > Outbound Webhooks (if this link does not work, it means that webhooks have not been enabled for your account yet — contact your CSM to get them enabled for you). You need to provide the information required for the webhook to know where and how to send your data. At the most basic level, you can configure your webhooks by including:

• The webhook’s name - how we will refer to the webhook in My.Extole.
• The client key - the secret (token for security) for the event you want to trigger the webhook for. Client Keys can be created by navigating to the Security Center, clicking + New Key, and selecting the Webhook option.
  • Supported secret types:
    • Password Authorization:Bearer <key>
    • HTTP_Basic Authorization:Basic <base64EncodedKey>
    • HS256 X-Extole-Signature:<hs_256_encoded_body_using_the_provided_key>
• The payload URL - the destination URL the webhook will POST to.
• An optional description for your webhook.
• Advanced Configuration is also optionally available to allow you more control over the structure and format of the data you’d like to receive in the request. If left undefined, the entire object will be POSTed as is.
  • If you need changes to the payload or to the events, please talk to your Solutions Architect. You can also let your Solutions Architect know what data you’d like to receive in the request and they can set this up for you.

Once you toggle onEnabled and hit Save , your webhook is activated and you may start receiving your data in whatever endpoints you set up upon the event’s occurrence.

​

Retries

If the webhook receives a non-200 response, we will retry 5 times: 1s, 1h, 3h, 12h, 12h. Then it will be placed in a dead letter queue for 7 days. If you need to see the events sent for a period of time, your Solutions Architect or Support Engineer can use the Webhook Events Report. Your Solutions Architect or Support Engineer can also post webhook events coming from reporting using the https://api.extole.com/v6/webhooks/events/send endpoint. It expects the body to the event, in its raw form.

​

Full Control

For each webhook, you can decide exactly what data should be leaving the platform. This means you can ensure data quality, and ensure that only specific types of data are sent off-platform. Once you’ve decided what data can be sent, you can then drill down into exactly what fields will be used. By mapping the data fields, you can have complete control over what data the external systems will get, and can see the exact JSON that will be sent by Extole.

​

Full Visibility

You have complete control over what data is sent and where, and you can also see exactly what has been sent and when. The Webhook Live Event view in Tech Center > Outbound Webhooks lets you track all webhook attempts and their status (including response code and message), making it easier to monitor and debug.

​

Full Support

Our Support, Solutions, Implementation, and Customer Success teams are always there to help you navigate through any configuration or setup questions you may have.