Compass logo

Using Webhooks

Use Webhooks to register URLs for Compass to notify whenever sessions are completed in your account. Process field and session data with your own internal systems.

Technical Details for Developers

We send a POST request containing a JSON payload to a secure HTTPS URL of your choosing. See below for an example of the payload data structure.

Payload Properties

Property Type Definition
key string Unique identifier for the session
started_at ISO 8601 string Date and time that the session began
completed_at ISO 8601 string Date and time that the session completed
workflow object The unique identifier and name of the workflow used during the session
fields array of objects Details about each completed field during the session

Example JSON payload

Example webhook JSON payload

Supported Actions

Send Message

Sends a POST request to a secure URL of your choosing with information about a completed session.

1. Enable Webhooks

To get started, you must enable Webhooks in your Compass account. Navigate to Integrations and select Enable on the Webhooks integration.

Compass software interface showing how to navigate to the integrations page

2. Add an Action to your Workflow

Now you can add the Send Message action for Webhooks to your Workflows. If you aren’t familiar with adding Actions to Workflows, we highly recommend that you read the article Adding Actions to a Section.

Navigate to Workflows and choose a Workflow. If you haven’t created a Workflow, we recommend that you read the article, Creating a Workflow and then return to this article.

Select the Section that will use the Action and then select Add Action, as seen below.

Compass software interface showing the add action button in a section for a workflow

Then follow the simple Setup Action process to add the Action. Once complete you’ll see the Webhooks Action added to the Section as seen below.

Compass software interface showing a Webhooks action added to a section

4. Use the Action in a Session

During a session, when you encounter a section of the workflow that includes a send message action, we’ll trigger it once the session is completed. No prompt will appear to fire Webhook actions as opposed to other integrations.

5. Reviewing Sent Actions

After you’ve completed the Session and fired the Actions, you will have access to a record of everything that happened during the Session.

If you aren’t familiar with the Session Record, we recommend you read the article, Reviewing a Completed Session Record.

From the Session Record, you can view the sent Actions and their details, as seen below.

Compass software interface showing a Webhooks action in a completed session

Nice work! Now you know all about Webhooks and can use Compass to collect information and then process it with your internal systems.

© 2019 Pacific Northwest Innovative Technologies, LLC