The Triggers APIs allow partners to create, manage, pause, restart, and delete triggers for connected apps.
A trigger listens for a specific event in an app, such as a new message, new row, or any other app-specific event. Once the trigger is created, it starts listening for the configured event using the selected app connection.
Partners can use these APIs to manage event listening outside the Embedded Journey instance flow, especially when triggers need to be controlled directly through APIs.
What you can do with Triggers APIs
| API | Purpose |
|---|---|
| Create trigger | Creates and registers a trigger for a selected app and connection |
| List triggers | Retrieves all triggers created under the authenticated partner account |
| Stop trigger | Temporarily stops an active trigger from listening for new events |
| Start trigger | Starts a stopped trigger and resumes event listening |
| Delete trigger | Permanently deletes a trigger that is no longer required |
Typical flow
- Create or identify a connection for the selected app.
- Get the app and trigger details from the Get app configuration API.
- Create a trigger using the
appAlias,triggerAlias,connectionId, and requiredinputvalues. - Use List triggers to view the created triggers and their active status.
- Stop or start the trigger when required.
- Delete the trigger when it is no longer needed.
Authentication
All Triggers APIs use the partner token.
Authorization: api-key <partner_token>