ByteChef LogoByteChef
Backend (API Key)App Events

Trigger all subscribed workflows

Fires an App Event for the connected user identified by external user id, starting every one of their enabled workflows that has an App Event trigger. Returns no body; inspect the runs through the workflow executions endpoints. The request body is read once and delivered to every matching workflow. If one or more workflows could not be started, the others still run and the response is a 500 problem detail whose failedWorkflows property lists the uuids of the workflows that were not started.

POST
/{externalUserId}/app-events

Authorization

bearerAuth
AuthorizationBearer <token>

In: header

Path Parameters

externalUserId*string

The external user id.

Header Parameters

X-Environment?string

The environment.

Value in

  • "DEVELOPMENT"
  • "STAGING"
  • "PRODUCTION"

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

curl -X POST "https://example.com/string/app-events"
Empty

How is this guide?

Embedded App Events

Fire an App Event for a connected user from your backend, starting every one of their subscribed workflows.

Embedded Request Trigger

Execute a single workflow of a connected user from your backend through its Request trigger and return its result.