Pular para o conteúdo

Setup Webhook

POST
/api/v1/webhooks/setup/{workflow_id}

Setup webhook for a workflow.

Generates webhook_key and webhook_secret if not already configured. Only works for workflows with trigger_type=“webhook”.

Returns:

  • webhook_key: Unique key for the webhook URL
  • webhook_secret: Secret for signature validation
  • webhook_url: Full URL to send webhooks to
workflow_id
required
Workflow Id
integer
x-tenant-id
Any of:
integer

Successful Response

WebhookSetupResponse

Response for webhook setup

object
webhook_key
required
Webhook Key
string
webhook_secret
required
Webhook Secret
string
webhook_url
required
Webhook Url
string
workflow_id
required
Workflow Id
integer
workflow_name
required
Workflow Name
string

Validation Error

HTTPValidationError
object
detail
Detail
Array<object>
ValidationError
object
loc
required
Location
Array
msg
required
Message
string
type
required
Error Type
string