API
Issue automation and webhooks
Automation rules and their runs, incoming automation webhooks, outgoing webhooks, and notifications.
See Tasks.
Every route below, with its parameters, request and response, errors and samples, is in the API reference.
| Route | What it does |
|---|---|
POST /v1/hooks/issues/:orgId/:ruleId/:token | Runs an incoming-webhook rule: on issues (keys) when given, otherwise on the rule's query; payload is available as {{payload.…}}. |
GET /v1/orgs/:orgId/issues/notifications | Notifications, newest first (unread=1 for unread only); page with cursor. |
GET /v1/orgs/:orgId/issues/notifications/count | How many notifications are unread. |
POST /v1/orgs/:orgId/issues/notifications/read | Marks notifications read (or unread with read: false); all: true for every one. |
GET /v1/orgs/:orgId/issues/notifications/settings | Email on or off, notifications about your own changes, and muted events. |
PUT /v1/orgs/:orgId/issues/notifications/settings | Changes what the caller hears about. |
GET /v1/orgs/:orgId/issues/automation | Rules the caller can see (space narrows to one space), with the trigger types there are. |
POST /v1/orgs/:orgId/issues/automation | Creates a rule. Rules for every space need issues:admin; space admins can automate their spaces. |
GET /v1/orgs/:orgId/issues/automation/:ruleId | A rule. |
PATCH /v1/orgs/:orgId/issues/automation/:ruleId | Changes a rule; pass baseVersion to avoid overwriting newer edits. |
DELETE /v1/orgs/:orgId/issues/automation/:ruleId | Deletes a rule. |
GET /v1/orgs/:orgId/issues/automation/:ruleId/runs | The last 50 runs of a rule. |
POST /v1/orgs/:orgId/issues/automation/:ruleId/run | Runs a manual rule on issues now. |
POST /v1/orgs/:orgId/issues/automation/:ruleId/token | Issues a new token for an incoming-webhook rule and returns its URL (shown once; the old one stops working). |
GET /v1/orgs/:orgId/issues/webhooks | Webhooks of the organization, with the events they can subscribe to. |
POST /v1/orgs/:orgId/issues/webhooks | Creates a webhook; the signing secret is in the response this once. |
GET /v1/orgs/:orgId/issues/webhooks/:webhookId | A webhook. |
PATCH /v1/orgs/:orgId/issues/webhooks/:webhookId | Changes a webhook. |
DELETE /v1/orgs/:orgId/issues/webhooks/:webhookId | Deletes a webhook. |
POST /v1/orgs/:orgId/issues/webhooks/:webhookId/secret | Replaces the signing secret (returned this once). |
POST /v1/orgs/:orgId/issues/webhooks/:webhookId/ping | Sends a ping event now and returns the outcome. |
GET /v1/orgs/:orgId/issues/webhooks/:webhookId/deliveries | The last 50 deliveries. |