Events & Integration
Outbound webhooks
Configure system.Webhook listeners that send Antly events to external URLs.
Outbound webhooks send Antly events to external systems. The core models are system.Webhook, system.WebhookListener, and system.WebhookListenerEvent.
system.Webhook stores the target URL, headers, name, and active flag. system.WebhookListener chooses what should trigger the webhook: namespace, intent, event, selected fields, filter/exclude bounds, delivery timing, and whether metadata is included. system.WebhookListenerEvent records delivery work and logs status, attempts, payload, checksum, and processing time.
Create a webhook target
1{
2 "__meta__": {
3 "schema": "model",
4 "namespace": "system.Webhook",
5 "intent": "create",
6 "authenticationClass": "jwt",
7 "return": {
8 "id": null,
9 "name": null,
10 "webhookUrl": null
11 }
12 },
13 "name": "CRM sync",
14 "webhook_url": "https://crm.example.com/antly/events",
15 "header_config": [
16 { "key": "X-Integration", "value": "antly" }
17 ]
18}Add a listener
1{
2 "__meta__": {
3 "schema": "model",
4 "namespace": "system.WebhookListener",
5 "intent": "create",
6 "authenticationClass": "jwt",
7 "return": {
8 "id": null,
9 "namespace": null,
10 "intent": null,
11 "event": null
12 }
13 },
14 "webhook": 12,
15 "namespace": "objects.Record",
16 "intent": "update",
17 "event": "objects.Record:update",
18 "fields": ["id", "object", "data", "modified"],
19 "filter": "{\"object__namespace\":\"Customer\"}",
20 "exclude": "{}",
21 "include_metadata": true,
22 "immediate": false
23}Listeners can reduce payload noise with fields, filter, and exclude. Leave immediate disabled for normal integrations so delivery can run through the background queue. Use immediate delivery only when the product flow must wait for the external call.
Receiver expectations
Your endpoint should be idempotent. Antly may retry failed events, and update events can supersede earlier queued work. Store the event trigger or checksum from the payload when you need replay protection.
For the admin-facing setup guide, see /guides/channel-integrations or /guides/workspace-administration. For JQL model operations, see /reference/crud-operations.