Basics
🛠️ Getting Started with Triggers
How to enable triggers & listen to them?
Using Triggers
Prerequisite: Successfully linking an account & then having connectedAccountId
.
Triggers are predefined conditions that, when met, initiate webhooks to your agents. These webhooks usually contain payloads which can be used to our advantage.
- Github Commit Event: Triggers a webhook whenever there is a new commit made to a particular repository.
- New email in inbox (Gmail): Triggers a webhook whenever a new email has been received.
Enabling Triggers
Listening to Triggers
Obtaining config parameters
You can find the list of triggers and the config parameters that need to be passed to each trigger to enable them with this APi call.
Handling Triggers
After completing the setup, the specified webhook URL will begin to receive data.
This data includes the connected_account_id
for account identification, trigger_id
for trigger identification, and the payload
, which adheres to the trigger’s specified payload schema.
Was this page helpful?