All Collections
Integrations & Data Management
Custom integrations
Creating custom integrations using Webhooks
Creating custom integrations using Webhooks

Configure incoming and outgoing Webhooks to share real-time data with Chameleon and other services

Chameleon Team avatar
Written by Chameleon Team
Updated over a week ago

πŸ§‘β€πŸ’» If you are an engineer looking to use webhooks then you can check out the webhooks section in our Developer Hub.

Availability & Usage

πŸ” Topics availability differs by plan

πŸ” Extendable limit of 5 outgoing Webhooks/account

πŸ“ Outgoing topics for Tours, Microsurveys, HelpBar

βš™οΈ Configure from the Dashboard

Webhooks are a way to send data between services in a real-time manner, with a simpler configuration than using APIs. You can use these to build custom integrations with other apps that also support Webhooks.

Chameleon offers support for webhooks in two ways:

  1. Update user data within Chameleon using Incoming Webhooks

  2. Send Chameleon data to other services using Outgoing Webhooks

Access the Chameleon webhooks configuration page from the Custom Integrations section in your Dashboard:

From 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 to 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

  • Microsurvey Button clicked

  • Microsurvey started

  • Microsurvey completed

  • Microsurvey exited

  • Microsurvey snoozed

  • Tour Button clicked

  • Tour stated

  • Tour completed

  • Tour exited

  • Tour snoozed

  • HelpBar search (the question)

  • HelpBar answer (provided by the AI)

  • HelpBar item action (when a resource is accessed in the HelpBar)

  • HelpBar item error (if a resource throws an error)

πŸ’‘ You can select one or more topic/s to send webhooks for.

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 the 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.

πŸ” 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 please email us.

The data within the Webhooks is outlined in detail in our Developer Documentation. 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 consolidate user feedback or preferences into your database or to leverage another tool to further engage and communicate with users based on their responses.

πŸ” There is a built-in limit of 5 outgoing Webhooks per account. Please contact us if you are in need of more.

More integrations

Did this answer your question?