Webhooks are a way to send data between services in a real-time manner, with simpler configuration than using APIs. If you are an engineer looking to use webhooks then you check out the webhooks section in our Developer Hub.
Chameleon offers support for webhooks in two ways:
- Update user data within Chameleon using Incoming Webhooks
- Send Chameleon data to other services using Outgoing Webhooks
You can get to the Chameleon webhooks configuration page from the Integrations section in your Chameleon dashboard:
From within the webhooks page, you'll see two sections, corresponding to Incoming and Outgoing Webhooks.
To use incoming webhooks, you will need to add the Chameleon webhook URL into the configuration page for the service sending the webhook.
For example, if you would like to send data from Marketo to Chameleon, you would need to configure the webhook within Marketo, and use the Chameleon end-point webhook URL there.
There are three types of data you can update within Chameleon using incoming webhooks.
- User properties
- Company properties
- User events
You should use the corresponding incoming webhook URL when adding it to the sending service. Simply hit "Copy" to grab this URL (which contains authentication for your account) and paste it into the sending service's configuration field.
Read more about limits and normalization of names in our Developer Hub here.
Outgoing webhooks can be used to send data from Chameleon to other services, and are available for the following "topics" ( fired whenever the associated event occurs):
- Microsurvey submitted
- Button clicked
- Tour stated
- Tour complted
- Tour exited
- Tour snoozed
You can create and configure your webhooks by selecting "Add webhook"
This will bring up a configuration modal where you can select the topic/s, provide a webhook name (to help you reference this in future), set the endpoint URL, and get the Account Secret.
The Endpoint URL will be provided from the service where the outgoing webhook data is being sent. You can use the Account Secret to verify the identity of your webhook (recommended). Read more about verification here.
You can select one or more topic/s to send webhooks for:
🔓 Note: the Microsurvey submitted webhook is available for all plans. The other webhook topics are only available on Chameleon's Growth Plan. If you'd like to discuss this plan or upgrade then please email us or select a time for a brief conversation from here.
The data within the webhooks is outlined in detail in our Developer Documentation here. For example, the Microsurvey submitted webhook contains:
- Microsurvey identity (see info here)
- Microsurvey Response (see detailed schema here)
- User identity (see info here)
This can be useful to consolidated user feedback or preferences into your database, or to leverage other tooling to further engage and communicate with users based on their responses.