Skip to main content

Workflows

This guide explains how to automate your processes using Osano’s webhooks and public API. If you have a custom-built integration and want to streamline your workflows, we’ll walk you through how Osano can help trigger actions and send status updates efficiently.

Overview of Automation Using Webhooks​

Osano provides a webhook-based solution that lets you automatically trigger actions on your end whenever events occur in our system. For example, you can configure webhooks to send data to your API when specific actions, such as DSAR (Data Subject Access Requests) submissions or consent updates, take place in Osano.

In this setup:

  • Osano’s Webhooks will notify your system when specific actions (like the creation of a DSAR action item) need to be addressed. - Your system will respond by handling the action (e.g., fulfilling the DSAR request).
  • Once the action is completed, your system will inform Osano via our public API, indicating that the action item has been addressed.

Setting Up Webhooks in Osano​

To start automating your workflow with Osano, follow these steps to set up webhooks:

  1. Login to My Osano: Visit my.osano.com and log in to your account.

  2. Navigate to Webhooks:

  • Once logged in, go to the Webhooks section of the app. Here, you can configure the events you want to trigger and the destination URLs where Osano should send the webhook data.
  1. Create a New Webhook:
    1. Click on “Create Webhook”
    2. Choose the relevant event you want to trigger the webhook on. For instance, if you want to automate actions related to DSAR requests, choose a DSAR-related event.
    3. Enter the URL where the webhook data should be sent (your API endpoint).
    4. Save the webhook configuration.

For more detailed guidance, you can refer to Osano’s Webhooks documentation here: Webhooks Documentation.

Setting Up the API on Your Side​

Once you’ve set up Osano’s webhooks to notify your system, the next step is to process the incoming data on your end. This typically involves:

  1. Create an Endpoint to Receive Webhooks:
    1. Your system will need an API endpoint that can accept the incoming webhook data from Osano. This endpoint will parse the payload and trigger the corresponding action in your system.
  2. Process the Incoming Webhook Data:
    1. When Osano sends a webhook, it will contain data about the event. For example, for a DSAR action item, it will contain information about the request (e.g., customer’s identity, the data involved).
    2. Your system should process this data and take the necessary actions (e.g., retrieving the requested data, performing necessary checks, etc.).
  3. Inform Osano When Action is Complete:
    1. Once your system has completed the required action (e.g., completed the DSAR request), your system needs to inform Osano by calling the Public API to update the action item’s status.

Using Osano’s API to Update Status​

Osano offers a public API that lets you update the status of DSAR requests and other action items once they’ve been completed.

  1. Authenticate and Access the API:
    1. To interact with the API, you need an API key. If you don’t have one yet, you can generate it from the API Settings section of My Osano.
  2. Update Action Item Status:
    1. When your system completes the required action, you will need to send a request to Osano’s API to update the action item’s status. For example, if you’ve completed a DSAR request, send a request to mark it as “completed.”
    2. Refer to the DSAR API Documentation for details on how to format this request. Example of an API request to update DSAR status:
POST /api/v1/dsar/{dsar_id}/status
Content-Type: application/json
Authorization: Bearer {your_api_key} { "status": "completed" }

This request will update the status of the corresponding DSAR action item in Osano’s system.

Error Handling and Retries​

If any errors occur during the process (for example, if your API endpoint is temporarily unavailable), you can set up retry mechanisms on your end to ensure webhook calls eventually succeed. Osano also retries failed webhook calls automatically. Be sure your system can handle these retries gracefully to prevent data loss.

Monitoring and Logging​

To keep everything running smoothly, be sure to implement proper monitoring and logging for both webhook activity and API interactions:

  • Log the incoming webhooks to verify that they are correctly received.
  • Track the responses to Osano’s API to make sure updates to action items are processed successfully.

Testing the Integration​

Before going live, it’s important to thoroughly test the integration:

  • Test webhooks in a sandbox environment to simulate the process.
  • Confirm that your system processes the incoming webhooks correctly, and the appropriate actions are taken.
  • Verify that once the action is completed, your system correctly sends the status update back to Osano.

Additional Context and Resources​

Dive into Osano’s Webhooks documentation to get more details on how to configure the specific events and endpoints you need.

Review the public API documentation to see how to interact with Osano’s APIs to mark action items as completed.