Integration Outbound Webhook
on 07-11-2024 12:00 AM by SnapApp by BlueVector AI
660
Overview
An Outbound Webhook allows SnapApp to send real-time data or event notifications from SnapApp to an external system using HTTP requests.
Whenever a specific event occurs inside SnapApp—such as a record update, workflow trigger, or automation action, SnapApp can automatically send an HTTP request (for example, POST, PUT, or PATCH) to a configured external URL.
Outbound webhooks are commonly used to:
- Sync SnapApp data with third-party systems
- Notify external services when records are created or updated
- Trigger actions in external platforms
- Integrate SnapApp workflows with custom APIs
Table of Contents
- Steps to create an Outbound Webhook
- 1. Navigate to Integrations
- 2. Create a New Integration
- 3. Configure Request Headers
- 4. Configure the Target URL
- 5. Select HTTP Request Method
- 6. Configure Authorization Type
- 7. Define the Request Body
- 8. Configure Response Actions (Workflows)
- 9. Save and Activate
- Summary
Steps to create an Outbound Webhook
Follow the steps below to configure an outbound webhook in SnapApp.
1. Navigate to Integrations
- Click on Settings from the user menu in the top navigation bar.
- From the left navigation panel, go to Automation → Integrations.
2. Create a New Integration
- Click Add New (+) in the top-right corner.
- Enter a meaningful Name for the integration.
- Select Outbound Webhook as the integration type.
- Choose the relevant Object ID from the dropdown list.
- Enable the Active toggle to activate the webhook.
3. Configure Request Headers
- Under the Headers section, add one or more authorization or custom headers.
- These headers are typically required for authentication by the external service.
- You can remove a header anytime using the icon.
Common examples include:
AuthorizationContent-Type- API keys or custom tokens
4. Configure the Target URL
- Enter the URL of the external service where SnapApp should send the request.
- This is usually an API endpoint provided by the external system.
Example:
https://api.external-service.com/webhook
5. Select HTTP Request Method
Choose the appropriate HTTP method based on the external API requirements:
GET– Fetch dataPOST– Send new dataPUT– Update existing dataPATCH– Partially update dataDELETE– Remove data
6. Configure Authorization Type
Select the authorization mechanism required by the external service:
- Basic – Username and password
- BearerToken – Token-based authentication
- APIkey – API key authentication
Example: Below, a Bearer Token authorization type is selected.
update.png)
7. Define the Request Body
- Add the Response Body in JSON format.
- This JSON defines the payload SnapApp will send to the external system.
- You can map SnapApp object fields dynamically into this JSON structure.
updated.png)
updated.png)
8. Configure Response Actions (Workflows)
- Under Response Actions, click the + icon to attach one or more workflows.
- These workflows run after the outbound webhook request is executed.
- This allows you to handle success, failure, or follow-up logic automatically.
.png)
9. Save and Activate
- Click Save to finalize the configuration.
- Your outbound webhook is now active.
- Whenever the configured event occurs, SnapApp will:
- Send the HTTP request to the external URL
- Include headers, authorization, and payload
- Execute any linked workflows
Summary
Outbound webhooks enable SnapApp to act as a data sender, pushing information to external systems instantly and reliably. They are ideal for real-time integrations, automation pipelines, and cross-platform workflows.
Thank you for configuring your SnapApp integration. If you have any questions or need further assistance, feel free to reach out to our support team.
For support, email us at snapapp@bluevector.ai