# Webhooks

## **Setting Up Webhooks**

<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&#x26;token=61f0a272-5424-44f4-baf5-2fedadb007e5" alt=""><figcaption></figcaption></figure>

#### **Accessing the Webhook Configuration**

To set up webhooks in Jimo:

1. Navigate to **Jimo Settings** > **Integrations**.
2. Select the **Webhook** tab: [Jimo Webhook Settings](https://i.usejimo.com/settings/integrations/webhook).

{% hint style="info" %}
📌 For a complete [**list of available webhook events**](https://app.gitbook.com/s/Q1pi3sC2zIV5o9Oa46Aq/for-developers/webhooks), visit the Webhook Event Reference.
{% endhint %}

***

### **Creating a New Webhook**

{% stepper %}
{% step %}
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&#x26;token=3fb60414-4c94-4b7f-a1f9-0f5cb13d5e22" alt=""><figcaption></figcaption></figure>
{% endstep %}

{% step %}
Enter a **Webhook Name** for easy identification.

<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&#x26;token=f363f07d-eac5-4f3c-ad84-cca5d6b17727" alt=""><figcaption></figcaption></figure>
{% endstep %}

{% step %}
Provide an **Endpoint URL**, which is the server address where Jimo will send the event data.

<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&#x26;token=4f403562-627e-409d-9f15-f6d98c42ff8a" alt=""><figcaption></figcaption></figure>
{% endstep %}

{% step %}
Click **Add Event** to choose the specific types of 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&#x26;token=5f6d853f-79a1-4a9e-8772-cc73edeabed9" alt="" width="563"><figcaption></figcaption></figure>
{% endstep %}

{% step %}
Save your webhook to start receiving data.

<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&#x26;token=e71a21b8-6016-442b-8c8e-c91d7d4a2189" alt=""><figcaption></figcaption></figure>
{% endstep %}
{% endstepper %}

{% hint style="warning" %}
📝 **Note:** Once an event is triggered, Jimo sends a structured payload to the specified endpoint URL. You are responsible for handling, filtering, and formatting the data received.
{% endhint %}

***

### **Managing Webhooks**

<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&#x26;token=05ae61ab-a8ca-4bd4-b7d3-01607f815c56" alt=""><figcaption></figcaption></figure>

Once created, you can:

* **View and edit** any existing webhook.
* **Pause or activate** a webhook to control whether it continues sending events.
* **Delete** a webhook if it is no longer needed.

***

## **Monitoring Webhook Events**

<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&#x26;token=0dc0e2cd-692b-4986-bf9b-600ca16fab49" alt=""><figcaption></figcaption></figure>

Each webhook maintains a history of triggered events:

1. Access your webhook from the list.
2. View the **event history**, which includes a timestamp and status (succeeded/failed).
3. Click on an event to inspect the **request payload** and **server response**.

***

## **Available Webhook Events**

Webhooks can track a wide range of actions, including:

* **User interactions** (e.g., when a user views a hint or completes a survey).
* **Experience management** (e.g., when a tour is created, published, or deleted).
* **System notifications** (e.g., when the MAU limit is reached).

{% hint style="info" %}
📌 For a complete [**list of available webhook events**](https://app.gitbook.com/s/Q1pi3sC2zIV5o9Oa46Aq/for-developers/webhooks), visit the Webhook Event Reference.
{% endhint %}


---

# Agent Instructions: Querying This Documentation

If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://help.usejimo.com/docs/integrations/webhooks.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.
