Webhooks
Allow Teammates to respond to third party systems events
Webhooks serve as a powerful mechanism to enable automated responses from a Teammate to events occurring within third-party systems, utilizing standard RESTful calls for communication. This feature allows for sophisticated integration, where the Teammate can perform actions based on specific events, such as a GitHub pull request being opened. The process for setting up and utilizing webhooks is structured into key components for clarity and efficiency:
Configuring Webhooks
To leverage webhooks, you need to configure them to listen for specific events in third-party systems. This involves specifying which events should trigger the webhook and detailing the actions that the Agent should take in response.
AI Instructions Prompt
As part of the webhook configuration, you must provide instructions in the form of a prompt. This prompt guides the Teammate on how to process the event, detailing the operations to perform with the context of the event's data.
Teammate Selection
You have the flexibility to select the relevant Teammate best suited for handling the task at hand. This ensures that the response is managed by the most appropriate resources, optimizing efficiency and effectiveness.
Dynamic Data Parsing with JMESPath
To enhance the utility and efficiency of webhooks, JMESPath can be integrated into the prompt template. This integration allows for the dynamic parsing of the event data, enabling you to refine the information sent to the Teammate. Rather than working with the entire event payload, JMESPath helps extract only the essential data needed for the Teammate to act on, ensuring a focused and relevant response to the event.
By structuring the webhook setup process around these components, you can create a streamlined and effective mechanism for your Teammate to interact with third-party systems, responding to events with precision and contextual relevance.
How to create a webhook?
Follow our guides on:
Last updated