Get Webhook Trigger

GET

/org/:org_id/project/:project_id/trigger/webhook/:trigger_id

GET

/api/v1/org/:org_id/project/:project_id/trigger/webhook/:trigger_id

$ curl https://app.rightbrain.ai/api/v1/org/org_id/project/project_id/trigger/webhook/trigger_id \
>      -H "Authorization: Bearer <token>"

1 {
2   "id": "019f8a25-4a1b-41ac-8f07-1b6c4d9e8032",
3   "target_type": "task",
4   "target_id": "0190a234-8dc6-6d08-aea9-928fcecad8f1",
5   "name": "helpdesk-inbound",
6   "status": "enabled",
7   "endpoint_id": "wh_k4Ttz1p-qXnR8",
8   "endpoint_url": "https://app.rightbrain.ai/api/v1/public/webhook/0190a234-9876-5432-10ab-cdef01234567/wh_k4Ttz1p-qXnR8",
9   "auth_method": "hmac_sha256",
10   "include_raw_payload": false,
11   "idempotency_ttl_seconds": 86400,
12   "created": "2026-07-28T09:15:22.481203Z",
13   "modified": "2026-07-28T09:15:22.481203Z",
14   "created_by_user_id": "0190c234-1111-2222-3333-444444444444",
15   "task_agent_revision_id": null,
16   "trigger_type": "webhook",
17   "description": "Fires the summariser when the helpdesk posts a ticket.",
18   "auth_config": {},
19   "payload_mapping": {
20     "text": "$.ticket.body"
21   },
22   "idempotency_key_path": null
23 }

Retrieve a webhook trigger. The signing secret is not included — rotate it if it has been lost.

Authentication

AuthorizationBearer

API key or access token, sent as Authorization: Bearer <token>. The simplest option: create an API key in your dashboard under Settings, then paste it here.

AuthorizationBearer

API key or access token, sent as Authorization: Bearer <token>. The simplest option: create an API key in your dashboard under Settings, then paste it here.

Path parameters

org_idstringRequiredformat: "uuid"

The organization ID

project_idstringRequiredformat: "uuid"

The project ID

trigger_idstringRequiredformat: "uuid"

Response

Webhook trigger details retrieved successfully

idstringformat: "uuid"

Unique identifier for the trigger.

target_typeenum

The target resource type for this trigger.

target_idstringformat: "uuid"

The target resource ID for this trigger.

namestring

A descriptive name for the trigger.

statusenum

Lifecycle status for the trigger (draft, disabled, enabled).

endpoint_idstring

Unique endpoint identifier used in the webhook URL.

endpoint_urlstring

Full URL for receiving webhook requests.

auth_methodstring

Authentication method for incoming webhooks.

include_raw_payloadboolean

Whether to include the entire payload as _raw_payload.

idempotency_ttl_secondsinteger

How long to remember processed idempotency keys.

createdstring

When the trigger was created.

modifiedstring

When the trigger was last updated.

created_by_user_idstringformat: "uuid"

User who created the trigger.

task_agent_revision_idstring or nullOptionalformat: "uuid"

Optional pinned TaskAgent revision for TaskAgent triggers.

trigger_type"webhook"OptionalDefaults to webhook

The type of trigger (webhook for this endpoint).

descriptionstring or nullOptional

Additional details about the trigger's purpose.

auth_configmap from strings to any or nullOptional

Authentication configuration (e.g., signature header name).

payload_mappingmap from strings to any or nullOptional

JSONPath mappings from webhook payload to Task inputs.

idempotency_key_pathstring or nullOptional

JSONPath to extract idempotency key from payload.

Errors

400

Bad Request Error

401

Unauthorized Error

403

Forbidden Error

404

Not Found Error

422

Unprocessable Entity Error

500

Internal Server Error