> For the complete documentation index, see [llms.txt](https://help.usejimo.com/docs/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://help.usejimo.com/docs/integrations/webhooks.md).

# Webhooks

Create a webhook in Settings > Integrations to send a JSON payload to your endpoint when the Jimo events you choose happen, then monitor each delivery.

A webhook sends a JSON payload to your endpoint each time an event you chose happens in Jimo: a tour completed, a survey answered, a banner published. Use it to sync Jimo with your backend, your CRM or your own notifications.

This page covers setting up and monitoring webhooks. The list of events, the payload format and the retry rules are in the developer reference.

{% content-ref url="/spaces/Q1pi3sC2zIV5o9Oa46Aq/pages/F9l3f3hUyGzdwdtL0wVi" %}
[Webhooks](https://help.usejimo.com/docs/for-developers/for-developers/webhooks.md)
{% endcontent-ref %}

## What you can receive

Events are grouped by experience: tours, surveys, checklists, hints, banners, changelog posts, and feedback. Each group has events for user interactions (started, completed, seen, answered, clicked) and for content changes (created, published, deleted, status changed). One more event, **Issue detected**, tells you when a user hits an issue on an experience: its target element was not found, not visible, or found several times. The full list, with the data each event carries, is in the [webhook events reference](https://help.usejimo.com/docs/for-developers/for-developers/webhooks/events.md).

<figure><img src="https://2794860263-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FKzAcDWQbK1gKbpra7bkb%2Fuploads%2FONFw8iyVcgfPmKL8HnLm%2FF2-56c-automation-out-webhooks.png?alt=media&amp;token=bee3f202-a63c-4a39-b599-9c4a343c466b" alt="Jimo sends the events you choose as a JSON payload to your endpoint. Slack and Zapier, the other outbound integrations, are greyed out"><figcaption></figcaption></figure>

## Before you start

* An endpoint URL that accepts requests from Jimo and answers with a status code below 400.
* A Jimo role with access to the Integrations settings. See [Integration setup](https://help.usejimo.com/docs/integrations/integration-setup.md).

## Create a webhook

Open [Settings > Integrations > Webhooks](https://i.usejimo.com/settings/integrations/webhook).

<figure><img src="https://2794860263-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FKzAcDWQbK1gKbpra7bkb%2Fuploads%2FD11ypoQY5tRpjI4jNm2V%2Fimage.png?alt=media&amp;token=61f0a272-5424-44f4-baf5-2fedadb007e5" alt="Webhooks settings page"><figcaption></figcaption></figure>

{% stepper %}
{% step %}

### Click New Webhook

Click **+ New Webhook**.

<figure><img src="https://2794860263-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FKzAcDWQbK1gKbpra7bkb%2Fuploads%2FzI5HN0v9F0343iw80vP1%2Fimage.png?alt=media&amp;token=3fb60414-4c94-4b7f-a1f9-0f5cb13d5e22" alt="New Webhook button"><figcaption></figcaption></figure>
{% endstep %}

{% step %}

### Name it

Enter a **Webhook Name** your team will recognize.

<figure><img src="https://2794860263-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FKzAcDWQbK1gKbpra7bkb%2Fuploads%2F5kB6LlVyWStRXrimdQaP%2Fimage.png?alt=media&amp;token=f363f07d-eac5-4f3c-ad84-cca5d6b17727" alt="Webhook name field"><figcaption></figcaption></figure>
{% endstep %}

{% step %}

### Enter the endpoint

Enter the **Endpoint URL**, the server address that receives the payloads.

<figure><img src="https://2794860263-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FKzAcDWQbK1gKbpra7bkb%2Fuploads%2Fnctw9jB1ugOF5pyurowq%2Fimage.png?alt=media&amp;token=4f403562-627e-409d-9f15-f6d98c42ff8a" alt="Endpoint URL field"><figcaption></figcaption></figure>
{% endstep %}

{% step %}

### Choose the events

Click **Add Event** and select the events you want to receive.

<figure><img src="https://2794860263-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FKzAcDWQbK1gKbpra7bkb%2Fuploads%2FWLFwLsAM3DnzSB94ld8E%2Fimage.png?alt=media&amp;token=5f6d853f-79a1-4a9e-8772-cc73edeabed9" alt="Add Event list"><figcaption></figcaption></figure>
{% endstep %}

{% step %}

### Save

Save the webhook. Jimo starts sending payloads for the events you selected.

<figure><img src="https://2794860263-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FKzAcDWQbK1gKbpra7bkb%2Fuploads%2Fy7FW2u8lXDT9lVn37Gqi%2Fimage.png?alt=media&amp;token=e71a21b8-6016-442b-8c8e-c91d7d4a2189" alt="Saved webhook"><figcaption></figcaption></figure>
{% endstep %}
{% endstepper %}

{% hint style="warning" %}
Jimo sends the payload as is. Your endpoint is responsible for filtering, formatting and storing what it receives.
{% endhint %}

## Manage and monitor

From the webhook list, you can view and edit a webhook, pause or activate it, or delete it.

<figure><img src="https://2794860263-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FKzAcDWQbK1gKbpra7bkb%2Fuploads%2FF6znh4csXAY3h4jENq17%2Fimage.png?alt=media&amp;token=05ae61ab-a8ca-4bd4-b7d3-01607f815c56" alt="Webhook list with actions"><figcaption></figcaption></figure>

Each webhook keeps a history of the events it sent, with a timestamp and a status (succeeded or failed). Click an event to see the request payload and your server's response. You can also retry a failed delivery from there.

<figure><img src="https://2794860263-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FKzAcDWQbK1gKbpra7bkb%2Fuploads%2FRE858h4617fdJLrC8pxp%2Fimage.png?alt=media&amp;token=0dc0e2cd-692b-4986-bf9b-600ca16fab49" alt="Webhook event history"><figcaption></figcaption></figure>

## Verify

Trigger a selected event yourself, for example by completing a tour on your app. Open the webhook's event history: the delivery shows with a succeeded status, and your endpoint has the payload.

## Common uses

#### Send Jimo events to a CRM

HubSpot and Salesforce integrations only read from the CRM. To write Jimo activity there, receive a webhook on your backend and call the CRM's API.

#### Notify a channel on a tour or checklist completion

The Slack integration posts survey responses only. For other events, receive a webhook and post to Slack from your backend or an automation tool.

#### Get alerted when an experience breaks

Select **Issue detected** and post each alert to your team's channel from your backend or an automation tool. You can fix a broken tour step before more users hit it. Jimo sends the alert at most once per hour for the same issue.

## Related

* [Webhooks reference](https://help.usejimo.com/docs/for-developers/for-developers/webhooks.md): payload format, retries
* [Webhook events](https://help.usejimo.com/docs/for-developers/for-developers/webhooks/events.md)
* [Server-side events](https://help.usejimo.com/docs/integrations/server-side-events.md): the opposite direction, from your backend to Jimo
* [Zapier](https://help.usejimo.com/docs/integrations/zapier.md): feedback and surveys to other apps, without code
