Skip to main content
POST
Create a workspace webhook endpoint

Path Parameters

workspace_id
string<uuid>
required

Workspace ID.

Body

application/json
name
string
required

Descriptive name for the integration.

Required string length: 1 - 80
url
string
required

Public HTTPS URL that will receive JSON POST requests.

Required string length: 1 - 2048
event_types
enum<string>[]
required

Events to deliver.

Required array length: 1 - 5 elements

Event type delivered to the webhook endpoint.

Available options:
post.mention
profile_ids
string<uuid>[]
required

Workspace profile IDs whose events should be delivered.

Required array length: 1 - 50 elements

Response

Agent Response Protocol success envelope.

Agent Response Protocol success envelope.

ok
enum<boolean>
required

Whether the API request completed successfully.

Available options:
true
data
object
required

Creates a signed webhook subscription for selected workspace profiles and event types. Requires an authenticated workspace owner or admin session. The signing secret is returned once.

agent
object
required

Wircle-generated context for AI agents. This object may be empty.