Skip to content
OpenBot

triggerHooks.fireTrigger

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

Gives the task of the trigger to its Bot. Send Authorization: Bearer <webhook secret>. The JSON body goes to the Bot as data, not as instructions. The task works for the actor of the trigger.

Parameters

Section titled “Parameters”

Path Parameters

Section titled “Path Parameters”
triggerId
required
string
>= 1 characters <= 128 characters

Header Parameters

Section titled “Header Parameters”
idempotency-key
required
string
>= 1 characters <= 128 characters

Request Bodyrequired

Section titled “Request Bodyrequired”
Media typeapplication/json

Example generated

example

Responses

Section titled “Responses”

202

Section titled “202”

Success

Media typeapplication/json
object
executionId
required
string
>= 1 characters <= 128 characters
commandKey
required
string
>= 1 characters <= 128 characters
sequence
required
integer
<= 9007199254740991
delegation
required
string
>= 1 characters <= 128 characters

Example generated

{
  "executionId": "example",
  "commandKey": "example",
  "sequence": 1,
  "delegation": "example"
}

401

Section titled “401”

TriggerHookDenied

Media typeapplication/json
object
_tag
required
string
Allowed values: TriggerHookDenied

Example 

{
  "_tag": "TriggerHookDenied"
}

403

Section titled “403”

ExecutionForbidden

Media typeapplication/json
object
_tag
required
string
Allowed values: ExecutionForbidden

Example 

{
  "_tag": "ExecutionForbidden"
}

404

Section titled “404”

ExecutionNotFound

Media typeapplication/json
object
_tag
required
string
Allowed values: ExecutionNotFound
id
required
string
>= 1 characters <= 128 characters

Example 

{
  "_tag": "ExecutionNotFound"
}

409

Section titled “409”

ExecutionConflict | ExecutionKeyConflict | TriggerInvalid

Media typeapplication/json
Any of:
object
_tag
required
string
Allowed values: ExecutionConflict
id
required
string
>= 1 characters <= 128 characters

Example 

{
  "_tag": "ExecutionConflict"
}

503

Section titled “503”

ExecutionUnavailable | TriggerStorageUnavailable | RequestFailed

Media typeapplication/json
Any of:
object
_tag
required
string
Allowed values: ExecutionUnavailable
errorId
required
string
>= 1 characters <= 128 characters

Example 

{
  "_tag": "ExecutionUnavailable"
}