Webhooks

Trigger a skill via webhook

Sends a webhook payload to trigger a skill (AI agent) run. The skill must have a webhook trigger configured and be in "live" status.

The entire JSON body is passed to the skill as input context, so you can send any structured data your skill needs.

Common use cases:

  • React to events from external services (Stripe, TypeForm, etc.)
  • Chain automation workflows across systems
  • Trigger skills from your own application on custom events

Optional signature verification: For enhanced security, include an HMAC-SHA256 signature in the x-webhook-signature header. The signature is computed over the raw JSON body using your API key as the secret.

post/api/webhooks/{skillId}

Request

  • Base URL
    https://app.useitem.io
  • Auth
    API key in header x-api-key

Headers

x-webhook-signaturestring

Optional HMAC-SHA256 signature for payload verification. Format: sha256={hex_signature}. Computed as HMAC-SHA256(raw_json_body, api_key).

Request body

object required

Any JSON object. Passed to the skill as input context.

Response

Skill triggered successfully

successboolean
skillRunIdstring uuid

ID of the created skill run

messagestring

Example response

{
  "success": true,
  "skillRunId": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
  "message": "Webhook received and skill triggered successfully"
}

Changes

No recorded changes to this operation across all 1 revision of this API.