Skip to main content

Documentation Index

Fetch the complete documentation index at: https://developers.chameleon.io/llms.txt

Use this file to discover all available pages before exploring further.

See the Webhooks page for information about the Webhooks that Chameleon sends to configured endpoints
See the configured Webhooks in your dashboard.

​
Schema

PropertyTypeDescription
idIDThe Chameleon ID
uidstringThe webhook url to POST to
namestringThe identifiable name for this webhook
last_item_attimestampLast time this webhook URL was POSTed to
last_item_statestringResult of the last POST to the URL. One of valid or error
last_item_errorstringDescription of the last non-2xx error code response

​
Listing Webhooks

Retrieve a complete (un-paginated) list of webhooks.

​
HTTP Request

GET
https://api.chameleon.io/v3/edit/webhooks
param-description
kindrequiredUse a values of either webhook or zapier_hook

​
HTTP Response

{
  "webhooks": [
    {
      "id": "5f3c4232c712de665632a6d9",
      "uid": "https://data.chameleon.io/where?is=it",
      "name": "Tour events to Data warehouse",
      "last_item_at": "2029-04-07T12:18:00Z",
      ...
    },
    {
      "id": "5f3c4232c712de665632a6e2",
      "uid": "https://hooks.other-system.com/N6bE1XGhTz5YbAQ?via=chameleon",
      "name": "Keep Other system up to date",
      ...
    },
    ...
  ]
}

​
Create a Webhook

Add a new Webhook endpoint (limited to 5 total)

​
HTTP Request

POST
https://api.chameleon.io/v3/edit/webhooks
param-description
kindrequiredThe type of webhook. One of webhook or zapier_hook. (defaults to webhook)
urlrequiredA https-based URL where webhooks are to be sent
topicsrequiredA comma-separated list OR Array of topics to send webhooks for. Any/all of the Webhook topics
experience_idoptionalA single Experience ID to send Webhooks for. An Experience is a Tour or Microsurvey
experience_idsrequiredAn array of Experience IDs to send Webhooks for. An Experience is a Tour or Microsurvey

​
HTTP Response

{
  "webhook": {
    "id": "5f3c4232c712de665632a6d9",
    "uid": "https://data.chameleon.io/where?is=it",
    ...
  }
}

​
Delete a Webhook

Remove a Webhook

​
HTTP Request

DELETE
https://api.chameleon.io/v3/edit/webhooks/:id
param-description
idrequiredThe Chameleon ID of the Webhook

​
HTTP Response

{
  "webhook": {
    "id": "5f3c4232c712de665632a6d9"
  }
}