Create Webhook
webex.create_webhook
ActionChat & messagingconnection required
Calls the Cisco Webex API with the connection's credentials.
Subscribe a URL to a Webex resource and event, e.g. new messages.
Connection
- Required
- Yes — the node will not save without one
- Auth type
- Bearer token
- Providers
- Cisco Webex
- Secret shape
- the Webex access token, or {"access_token": "…"}
- Resolved by
- config.connection_id, else node.connection_id
Configuration
6 fields, 4 required. A dotted path is a nested object and name[] an array of objects — the editor renders the same tree.
| Field | Type | Required | Default | Constraints | Example |
|---|---|---|---|---|---|
name A name for the webhook, shown in the Webex developer portal. | string | Yes | — | — | New messages to the ops space |
target_url The public https URL Webex should POST each event to — a Mantle webhook trigger's URL, for instance. | string | Yes | — | url format | — |
resource Which resource to watch. | string | Yes | — | one of "messages", "memberships", "rooms", "meetings", "recordings", "meetingParticipants", "meetingTranscripts", "attachmentActions" | — |
event Which change to that resource to watch. | string | Yes | — | one of "created", "updated", "deleted", "started", "ended" | — |
filter Narrow the subscription, e.g. roomId=<id> or mentionedPeople=me. Without one, every event of that resource arrives. | string | No | — | — | — |
secret A shared secret Webex uses to sign each callback (X-Spark-Signature). | string | No | — | credential material | credential |
Example configuration
Every value below is the contract’s own example or default — nothing invented.
{
"name": "New messages to the ops space"
}Output
One shape.
result
| Field | Type | Example |
|---|---|---|
id The webhook id — pass it to webex.delete_webhook. | string | — |
name The webhook's name. | string | — |
target_url The URL Webex POSTs each event to. | string | — |
resource The resource it watches, e.g. messages. | string | — |
event The event it watches, e.g. created. | string | — |
filter The filter narrowing it, e.g. roomId=…. | string | — |
status 'active', or 'inactive' after Webex gave up on the URL. | string | — |
created When the webhook was created (ISO-8601). | string | — |
{
"created": "",
"event": "",
"filter": "",
"id": "",
"name": "",
"resource": "",
"status": "",
"target_url": ""
}Notes
- The connection's token is the actor: a bot token only sees the spaces the bot has been added to, and a personal or integration token acts as that user.
- Webex only delivers events the token itself can see, so a bot receives messages from the spaces it is in.
- A target URL that keeps failing is set to inactive by Webex; check status with webex.list_webhooks.
See Create Webhook run in a workflow.
In a technical demo we add the Cisco Webex connection, drop the node on the canvas and let Workflow Health pre-flight it before the first real run.