Webhooks

Webhooks allow you to receive real-time data from Jimo whenever specific events occur. By setting up webhooks, you can automate workflows, synchronize data with external systems, or trigger actions.

Setting Up Webhooks

Accessing the Webhook Configuration

To set up webhooks in Jimo:

  1. Navigate to Jimo Settings > Integrations.

  2. Select the Webhook tab: Jimo Webhook Settings.

📌 For a complete list of available webhook events, visit the Webhook Event Reference.

Creating a New Webhook

1

Click + New Webhook.

2

Enter a Webhook Name for easy identification.

3

Provide an Endpoint URL, which is the server address where Jimo will send the event data.

4

Click Add Event to choose the specific types of events you want to receive.

5

Save your webhook to start receiving data.

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

Managing Webhooks

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

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

📌 For a complete list of available webhook events, visit the Webhook Event Reference.

PreviousServer-Side Events

Last updated

Was this helpful?