triggerHooks.fireTrigger

POST

/v1/hooks/triggers/{triggerId}

curl --request POST \
  --url https://example.com/v1/hooks/triggers/example \
  --header 'Content-Type: application/json' \
  --data '"example"'

Starts a new Session with the prompt of the trigger. Send Authorization: Bearer <webhook secret>. The JSON body goes to the Bot as data, not as instructions. The Session works for the actor of the trigger.

Parameters

Path Parameters

triggerId

required

string

>= 1 characters <= 128 characters

Request Body^required

Media typeapplication/json

Example ^generated

example

Responses

202

Success

Media typeapplication/json

object

session

required

string

Example ^generated

{
  "session": "example"
}

401

TriggerHookDenied

Media typeapplication/json

object

_tag

required

string

Allowed values: TriggerHookDenied

Example

{
  "_tag": "TriggerHookDenied"
}

503

TriggerStorageUnavailable

Media typeapplication/json

object

_tag

required

string

Allowed values: TriggerStorageUnavailable

Example

{
  "_tag": "TriggerStorageUnavailable"
}