Agentuity Documentation

Manage webhook endpoints, destinations, receipts, deliveries, and analytics.

Region

https://catalyst-usw.agentuity.cloud

Authentication

All requests require a Bearer token. Pass your SDK key in the Authorization header.

Header	Value
`Authorization`	`Bearer YOUR_SDK_KEY`

You can find your SDK key in the Agentuity Console under your project settings.

Webhook Management

Create Webhook

Create a new webhook endpoint.

POST/webhook/create

https://catalyst-usw.agentuity.cloud/webhook/create

Request Body

Webhook creation payload.

Field	Type	Description
`name`	string	Human-readable name for the webhook
`description`	string	Optional description of the webhook's purpose (optional)

Response

Returns the created webhook. The ingest URL is only returned at creation.

Status	Description
201	Webhook created
401	Unauthorized — invalid or missing Bearer token

Response Fields

Field	Type	Description
`id`	string	Unique identifier for the webhook (prefixed with wh_)
`created_at`	string	ISO 8601 timestamp when the webhook was created
`updated_at`	string	ISO 8601 timestamp when the webhook was last updated
`created_by`	string	ID of the user who created the webhook
`name`	string	Human-readable webhook name
`description`	string \| null	Optional description of the webhook's purpose
`url`	string	Fully-qualified ingest URL for sending events to this webhook. Only present on create (optional)
`internal`	boolean	Whether this is a system-managed webhook (e.g., S3 bucket notifications). Internal webhooks cannot be modified or deleted by users
`metadata`	object \| null	System metadata for internal webhooks (e.g., bucket_name, type). Null for user-created webhooks

Example

curl -X POST 'https://catalyst-usw.agentuity.cloud/webhook/create' \
  -H 'Authorization: Bearer $AGENTUITY_SDK_KEY' \
  -H 'Content-Type: application/json' \
  -d '{
  "name": "Payment Events"
}'

Get Webhook

Get a specific webhook by ID.

GET/webhook/get/{webhookId}

https://catalyst-usw.agentuity.cloud/webhook/get/{webhookId}

Parameters

path

Name	Type	Required	Description
`webhookId`	string	Yes	Webhook ID (wh_ prefix)

Response

Returns the webhook object.

Status	Description
200	Webhook returned
401	Unauthorized — invalid or missing Bearer token
404	Webhook not found

Example

curl -X GET 'https://catalyst-usw.agentuity.cloud/webhook/get/wh_abc123' \
  -H 'Authorization: Bearer $AGENTUITY_SDK_KEY'

List Webhooks

List all webhooks with optional pagination.

GET/webhook/list

https://catalyst-usw.agentuity.cloud/webhook/list

Parameters

query

Name	Type	Required	Description
`limit`	number	No	Maximum results to return
`offset`	number	No	Pagination offset

Response

Returns paginated list of webhooks.

Status	Description
200	Webhooks returned
401	Unauthorized — invalid or missing Bearer token

Example

curl -X GET 'https://catalyst-usw.agentuity.cloud/webhook/list' \
  -H 'Authorization: Bearer $AGENTUITY_SDK_KEY'

Update Webhook

Update a webhook's name or description.

PUT/webhook/update/{webhookId}

https://catalyst-usw.agentuity.cloud/webhook/update/{webhookId}

Parameters

path

Name	Type	Required	Description
`webhookId`	string	Yes	Webhook ID

Request Body

Webhook update payload.

Field	Type	Description
`name`	string	New name for the webhook
`description`	string	New description for the webhook (optional)

Response

Returns the updated webhook.

Status	Description
200	Webhook updated
401	Unauthorized — invalid or missing Bearer token
404	Webhook not found

Example

curl -X PUT 'https://catalyst-usw.agentuity.cloud/webhook/update/wh_abc123' \
  -H 'Authorization: Bearer $AGENTUITY_SDK_KEY' \
  -H 'Content-Type: application/json' \
  -d '{
  "name": "Updated Webhook"
}'

Delete Webhook

Delete a webhook and all associated destinations, receipts, and deliveries.

DELETE/webhook/delete/{webhookId}

https://catalyst-usw.agentuity.cloud/webhook/delete/{webhookId}

Parameters

path

Name	Type	Required	Description
`webhookId`	string	Yes	Webhook ID

Response

Deletes the webhook and all associated destinations, receipts, and deliveries.

Status	Description
204	Webhook deleted
401	Unauthorized — invalid or missing Bearer token
404	Webhook not found

Example

curl -X DELETE 'https://catalyst-usw.agentuity.cloud/webhook/delete/wh_abc123' \
  -H 'Authorization: Bearer $AGENTUITY_SDK_KEY'

Destinations

Create Destination

Add a destination to a webhook.

POST/webhook/destination-create/{webhookId}

https://catalyst-usw.agentuity.cloud/webhook/destination-create/{webhookId}

Parameters

path

Name	Type	Required	Description
`webhookId`	string	Yes	Webhook ID

Request Body

Destination creation payload.

Field	Type	Description
`type`	string	Type of destination to create
`config`	object	Configuration object for the destination

Response

Returns the created destination.

Status	Description
201	Destination created
401	Unauthorized — invalid or missing Bearer token
404	Webhook not found

Example

curl -X POST 'https://catalyst-usw.agentuity.cloud/webhook/destination-create/wh_abc123' \
  -H 'Authorization: Bearer $AGENTUITY_SDK_KEY' \
  -H 'Content-Type: application/json' \
  -d '{
  "type": "url",
  "config": {
    "url": "https://example.com/handler"
  }
}'

List Destinations

List all destinations for a webhook.

GET/webhook/destination-list/{webhookId}

https://catalyst-usw.agentuity.cloud/webhook/destination-list/{webhookId}

Parameters

path

Name	Type	Required	Description
`webhookId`	string	Yes	Webhook ID

Response

Returns list of destinations.

Status	Description
200	Destinations returned
401	Unauthorized — invalid or missing Bearer token
404	Webhook not found

Example

curl -X GET 'https://catalyst-usw.agentuity.cloud/webhook/destination-list/wh_abc123' \
  -H 'Authorization: Bearer $AGENTUITY_SDK_KEY'

Update Destination

Update a destination's configuration.

PUT/webhook/destination-update/{webhookId}/{destinationId}

https://catalyst-usw.agentuity.cloud/webhook/destination-update/{webhookId}/{destinationId}

Parameters

path

Name	Type	Required	Description
`webhookId`	string	Yes	Webhook ID
`destinationId`	string	Yes	Destination ID (whds_ prefix)

Request Body

Destination update payload.

Field	Type	Description
`config`	object	Updated configuration object for the destination (optional)

Response

Returns the updated destination.

Status	Description
200	Destination updated
401	Unauthorized — invalid or missing Bearer token
404	Webhook or destination not found

Example

curl -X PUT 'https://catalyst-usw.agentuity.cloud/webhook/destination-update/wh_abc123/whds_def456' \
  -H 'Authorization: Bearer $AGENTUITY_SDK_KEY' \
  -H 'Content-Type: application/json' \
  -d '{
  "config": {
    "url": "https://example.com/new-handler"
  }
}'

Delete Destination

Delete a destination from a webhook.

DELETE/webhook/destination-delete/{webhookId}/{destinationId}

https://catalyst-usw.agentuity.cloud/webhook/destination-delete/{webhookId}/{destinationId}

Parameters

path

Name	Type	Required	Description
`webhookId`	string	Yes	Webhook ID
`destinationId`	string	Yes	Destination ID

Response

Empty response on success.

Status	Description
204	Destination deleted
401	Unauthorized — invalid or missing Bearer token
404	Webhook or destination not found

Example

curl -X DELETE 'https://catalyst-usw.agentuity.cloud/webhook/destination-delete/wh_abc123/whds_def456' \
  -H 'Authorization: Bearer $AGENTUITY_SDK_KEY'

Receipts

List Receipts

List incoming request records (receipts) for a webhook.

GET/webhook/receipt-list/{webhookId}

https://catalyst-usw.agentuity.cloud/webhook/receipt-list/{webhookId}

Parameters

path

Name	Type	Required	Description
`webhookId`	string	Yes	Webhook ID

query

Name	Type	Required	Description
`limit`	number	No	Maximum results to return
`offset`	number	No	Pagination offset

Response

Returns incoming request records (receipts) for a webhook.

Status	Description
200	Receipts returned
401	Unauthorized — invalid or missing Bearer token
404	Webhook not found

Example

curl -X GET 'https://catalyst-usw.agentuity.cloud/webhook/receipt-list/wh_abc123' \
  -H 'Authorization: Bearer $AGENTUITY_SDK_KEY'

Get Receipt

Get a specific receipt by ID.

GET/webhook/receipt-get/{webhookId}/{receiptId}

https://catalyst-usw.agentuity.cloud/webhook/receipt-get/{webhookId}/{receiptId}

Parameters

path

Name	Type	Required	Description
`webhookId`	string	Yes	Webhook ID
`receiptId`	string	Yes	Receipt ID (whrc_ prefix)

Response

Returns the receipt with headers and payload.

Status	Description
200	Receipt returned
401	Unauthorized — invalid or missing Bearer token
404	Webhook or receipt not found

Response Fields

Field	Type	Description
`id`	string	Unique identifier for the receipt (prefixed with whrc_)
`date`	string	ISO 8601 timestamp when the receipt was recorded
`webhook_id`	string	ID of the webhook this receipt belongs to
`headers`	object	HTTP headers from the incoming webhook request
`payload`	any	Raw payload from the incoming webhook request (can be any type)

Example

curl -X GET 'https://catalyst-usw.agentuity.cloud/webhook/receipt-get/wh_abc123/whrc_def456' \
  -H 'Authorization: Bearer $AGENTUITY_SDK_KEY'

Deliveries

List Deliveries

List delivery attempts for a webhook.

GET/webhook/delivery-list/{webhookId}

https://catalyst-usw.agentuity.cloud/webhook/delivery-list/{webhookId}

Parameters

path

Name	Type	Required	Description
`webhookId`	string	Yes	Webhook ID

query

Name	Type	Required	Description
`limit`	number	No	Maximum results to return
`offset`	number	No	Pagination offset

Response

Returns list of delivery attempts.

Status	Description
200	Deliveries returned
401	Unauthorized — invalid or missing Bearer token
404	Webhook not found

Example

curl -X GET 'https://catalyst-usw.agentuity.cloud/webhook/delivery-list/wh_abc123' \
  -H 'Authorization: Bearer $AGENTUITY_SDK_KEY'

Retry Delivery

Retry a failed delivery. Only deliveries with 'failed' status can be retried.

POST/webhook/delivery-retry/{webhookId}/{deliveryId}

https://catalyst-usw.agentuity.cloud/webhook/delivery-retry/{webhookId}/{deliveryId}

Parameters

path

Name	Type	Required	Description
`webhookId`	string	Yes	Webhook ID
`deliveryId`	string	Yes	Delivery ID (whdv_ prefix)

Response

Retries a failed delivery. Only deliveries with 'failed' status can be retried.

Status	Description
200	Delivery retried
401	Unauthorized — invalid or missing Bearer token
404	Webhook or delivery not found

Example

curl -X POST 'https://catalyst-usw.agentuity.cloud/webhook/delivery-retry/wh_abc123/whdv_def456' \
  -H 'Authorization: Bearer $AGENTUITY_SDK_KEY' \
  -H 'Content-Type: application/json' \
  -d '{}'

Analytics

Get Org Analytics

Get aggregate webhook analytics for the organization.

GET/webhook/analytics/org

https://catalyst-usw.agentuity.cloud/webhook/analytics/org

Parameters

query

Name	Type	Required	Description
`start`	string	No	ISO 8601 start date
`end`	string	No	ISO 8601 end date
`granularity`	string	No	'minute', 'hour', or 'day'

Response

Returns aggregate analytics including total received, delivered, and failed counts.

Status	Description
200	Analytics returned
401	Unauthorized — invalid or missing Bearer token

Example

curl -X GET 'https://catalyst-usw.agentuity.cloud/webhook/analytics/org' \
  -H 'Authorization: Bearer $AGENTUITY_SDK_KEY'

Get Analytics Time Series

Get time series webhook analytics for the organization.

GET/webhook/analytics/org/timeseries

https://catalyst-usw.agentuity.cloud/webhook/analytics/org/timeseries

Parameters

query

Name	Type	Required	Description
`start`	string	No	ISO 8601 start date
`end`	string	No	ISO 8601 end date
`granularity`	string	No	'minute', 'hour', or 'day'

Response

Returns time series data with received, delivered, and failed counts per time bucket.

Status	Description
200	Time series data returned
401	Unauthorized — invalid or missing Bearer token

Example

curl -X GET 'https://catalyst-usw.agentuity.cloud/webhook/analytics/org/timeseries' \
  -H 'Authorization: Bearer $AGENTUITY_SDK_KEY'