Webhooks
Use an outgoing webhook when an event in your app should send data to a service that provides an incoming webhook URL.
Create and store the webhook
- Create an incoming webhook in the destination service.
- Copy its URL.
- Store the URL in Secrets with a descriptive name such as
SIGNUP_WEBHOOK_URL.
Treat the URL as a credential. Do not paste it into chat, source code, logs, screenshots, or client-side code.
Describe the event and payload
Tell the agent when to send the webhook, which fields to include, and how to handle failures:
Specify whether a failed webhook should block the user action, retry in the background, or only record an error. For important events, request idempotency or another duplicate-delivery safeguard supported by the destination.
Test the webhook
Use test credentials and non-sensitive sample data first. Verify:
- The event sends exactly once under normal conditions.
- The payload matches the destination's expected schema.
- Timeouts and non-success responses are handled without exposing the URL.
- Retries do not create duplicate records or notifications.
Related
- Call an External API — implement a request-and-response API workflow.
- Custom Integration — store reusable context for a service.
- Testing — cover the app behavior that triggers the webhook.