Test Webhooks

Right now, there are two main ways to validate your webhooks.

1. Mock Webhooks
2. Integration Testing

Mock Webhooks

To independently test your webhook endpoint, you can use the following POST request bodies to create and test sample webhooks. Depending on how you decided to authenticate you endpoint, this process may vary in difficulty.

Create A Visit

Before start testing, we recommend first having a visit to test with. If you don't have one already, please see this endpoint to learn how to create a visit.

Visit Not Started

{
     "type": "visit", 
     "visit_id": <YOUR_VISIT_ID>, 
     "new_status": "not_started", 
     "assignee": null,
     "meta": null
}

{
     "type": "visit", 
     "visit_id": <YOUR_VISIT_ID>, 
     "new_status": "rescheduled", 
     "assignee": null,
     "meta": null
}

Visit Started

{
     "type": "visit", 
     "visit_id": <YOUR_VISIT_ID>, 
     "new_status": "in_progress", 
     "assignee": null,
     "meta": null
}

Visit Completed

{
     "type": "visit", 
     "visit_id": <YOUR_VISIT_ID>, 
     "new_status": "complete", 
     "assignee": null,
     "meta": null
}

{
     "type": "visit", 
     "visit_id": <YOUR_VISIT_ID>, 
     "new_status": "incomplete", 
     "assignee": null,
     "meta": null
}

{
     "type": "visit", 
     "visit_id": <YOUR_VISIT_ID>, 
     "new_status": "requires_reschedule", 
     "assignee": null,
}

{
     "type": "visit", 
     "visit_id": <YOUR_VISIT_ID>, 
     "new_status": "other", 
     "assignee": null,
     "meta": null
}

Visit Canceled

{
     "type": "visit", 
     "visit_id": <YOUR_VISIT_ID>, 
     "new_status": "canceled"
     "assignee": null,
     "meta": null
}

Integration Testing

To test against a live workflow, please reach out to us at [email protected].

The process will look as follows:

1. We schedule a meeting together.
2. During the meeting, you provide a visit id to test against.
3. We simulate the completion of a that visit from start to finish.