Getting started with developer API at SYNQ
Webhooks are a powerful way to receive real-time notifications from SYNQ when specific events occur. This integration allows external applications to stay updated without the need for constant polling, thus saving resources and ensuring timely updates.
SYNQ uses webhooks to send HTTP POST requests to a predefined URL whenever certain events occur. These events could range from a new issue being created, an existing issue being updated, or even a simple ping to confirm that the webhook endpoint is reachable.
Webhooks in SYNQ are defined by a schema that ensures the correct data structure is maintained. Each event has a specific payload format, allowing external applications to process the event data accordingly.
Latest schema definition is available here.
To view documentation for the latest version of the API, visit events documentation.
issue_created
, issue_updated
, issue_closed
, and ping
.The webhook event schema defines the structure of the payload sent for each event type:
workspace
: Identifies the workspace where the event occurred.event_id
: A unique identifier for the event.event_time
: The time when the event occurred, formatted as a date-time string.event types
: One of the specific event types (ping
, issue_created
, issue_updated
, issue_closed
), each with its own structured payload.callbacks
: An array of callbacks that can be invoked based on the event, containing details such as url
, action_name
, and associated issues_command
.message
.issue_id
, group_id
, and message
.issue_created
event.issue_created
and issue_updated
events.To start using SYNQ webhooks:
Here’s an example of a webhook event payload for an issue created: