Webhook

Automate processes by responding to real-time events from external applications

Introduction

The Webhook feature in DBSync Cloud Workflow enables you to automate processes by responding to real-time events from external applications. Webhooks are a powerful way to initiate workflows based on specific actions, such as the creation, update, or deletion of data in applications like Salesforce, QuickBooks Online, or others.

By subscribing to webhooks, you can have your workflow triggered automatically when certain events occur in these external systems. This eliminates the need for manual intervention and allows for seamless integrations between different platforms, ensuring that your workflows stay up-to-date with the latest changes in real time.

In the Webhook section of DBSync Cloud Workflow, you can select the triggering application (like Salesforce or QuickBooks Online), choose the objects (e.g., Account, Invoice, etc.) that will initiate the workflow, and define the specific operations (insert, update, or delete) that will trigger the webhook. Once configured, the webhook will listen for these events and activate the corresponding workflow whenever the specified conditions are met.

Key Operations

The following fields are available within the Webhook tab.

Triggering App: This section allows you to select the app that will trigger the webhook.

  • Field: Object

    • You can choose from various apps such as QuickBooks Online, Salesforce, and others. In the screenshot, the app options are shown as a drop-down menu, allowing you to select the relevant app for your workflow.

  • Functionality: You need to select the app that will initiate a webhook based on certain events or actions within that app.

Subscribe Button: After selecting the desired app and object, you click on the Subscribe button to initiate the webhook subscription.

  • Functionality: Clicking Subscribe will trigger the webhook to start listening to the selected app for the specified object and operations, making the system respond to these events by triggering workflows.

Object: This field lists the available objects for the selected application. These objects represent the entities or data structures that can trigger the webhook.

  • Example: In the Salesforce screenshot, various objects are listed, such as AIApplication, Account, and AccountChangeEvent.

  • Functionality: Check the boxes next to the objects you want to subscribe to. These objects will be monitored for changes or updates.

Operation: For each selected object, this column allows you to specify which operations should trigger the webhook.

  • Options:

    • Insert: The webhook will be triggered when a new record is created for the selected object.

    • Update: The webhook will trigger when an existing record is updated.

    • Delete: The webhook will trigger when a record is deleted.

  • Functionality: You can choose multiple operations (insert, update, delete) for each object. For instance, in the Account object example, the webhook is set to trigger on insert, update, and delete operations.

Additional Object Examples: In the screenshots, objects like AIApplicationConfig, AccountChangeEvent, and AcceptedEventRelation are listed, showcasing different Salesforce objects that can be subscribed to for webhook triggers.

  • Functionality: You can select multiple objects and operations, allowing the webhook to listen for changes across various data points within the chosen application.

Operations Checkboxes: For each object listed in the Object column, you can choose which operations (insert, update, delete) should trigger the webhook. You can enable or disable these operations based on your needs.

  • Functionality: Check or uncheck the boxes corresponding to the operations you want the webhook to listen for. For instance:

    • For the Account object, check insert, update, and delete to trigger the webhook whenever an account is inserted, updated, or deleted.

Instructions and Notes: The screen includes a note that some events may be disabled by default, and a reminder to contact support if you need to subscribe to these events.

  • Functionality: This provides helpful information regarding event availability and support for configuring specific webhooks.

Additional Features

  • Filter or Search: If you have a long list of objects, there may be a search or filter option (although not explicitly shown in the screenshot, this is a common feature) to help you quickly find specific objects or operations to subscribe to.

  • Unsubscribe or Modify Subscription: Depending on your system’s design, you can either unsubscribe from events or modify your subscriptions by unchecking operations or objects.

The Webhook tab provides functionality for configuring automatic triggers based on events in external applications like Salesforce and QuickBooks Online. By subscribing to specific objects and operations, you can set up webhooks that allow your workflows to be triggered in real-time whenever the chosen events occur, helping you automate and streamline processes more effectively.

Last updated