Configure webhooks to integrate external applications
Overview#
Shorter Loop's Custom Outgoing Webhooks allow you to push real-time data from your workspace to external applications. Whenever a work item (Idea, Issue, Epic, Feature, or User Story) is created, updated, or deleted, Shorter Loop can send a JSON payload to a URL of your choice.This enables you to build custom integrations, trigger automation flows (e.g., Zapier, Make), or sync data with internal tools.
Configuration#
1. Create a Webhook#
To set up a webhook, navigate to Product Settings → Integrations → Webhooks.Webhook Name: A descriptive name for your integration (e.g., "Slack Notification", "Data Warehouse Sync").
Base URL: The endpoint URL where Shorter Loop will send the POST request. This must be a valid, publicly accessible URL.
Access Scope: Choose which types of data you want to receive events for:Backlog Work Items: Epics, Features, User Stories.
Feedback Manager Work Items: Ideas, Issues.
3. Manage Webhooks#
Once created, you can view, copy the URL, or delete webhooks from the list view.
API Reference#
Trigger Events#
The webhook is triggered immediately after any of the following actions occur on a supported work item:Create: A new item is added.
Update: An existing item is modified (e.g., status change, description update).
Delete: An item is removed (soft deleted).
POST request to your configured Base URL.Payload: The payload contains the raw data of the modified work item. The structure varies slightly depending on the item type, but generally includes the following fields:{
"id": 12345,
"title": "As a user, I want to login via SSO",
"description": "<p>Implement SAML 2.0...</p>",
"status": "in-progress",
"priority": "high",
"type": "story",
"externalKey": "US-101",
"initiativeId": 50,
"subscriptionId": 10,
"createdAt": "2023-10-27T10:00:00.000Z",
"updatedAt": "2023-10-28T14:30:00.000Z",
"userId": 5,
"tags": [
{ "id": 1, "key": "security", "slug": "security" }
],
...other_fields
}
Supported Models & Scopes#
| Scope | Models Included |
|---|
| Backlog Work Items | Epic, Feature, User Story |
| Feedback Manager | Idea, Issue |
The system automatically filters events based on the Access Scope you selected during setup. For example, if you only checked "Feedback Manager Work Items", you will not receive payloads for User Story updates.Best Practices#
1.
Idempotency: Your endpoint should handle duplicate events gracefully. Use the
id or externalKey field to identify unique records.
2.
Timeout: Shorter Loop expects a response within 10 seconds. Ensure your endpoint processes the request quickly or offloads heavy processing to a background queue.
3.
Security: Verify the source of the request if possible (e.g., by using a secret token in the URL query parameters, though Shorter Loop currently sends a standard payload).
4.
Error Handling: If your endpoint returns a non-200 status code, Shorter Loop logs the error but does not currently implement an automatic retry mechanism with exponential backoff for custom webhooks.
Modified at 2026-08-07 07:05:50
