A webhook is an endpoint on your server that receives requests from Setster, notifying you about events that happen on your account, such as an appointment change. Once a webhook is set up, Setster will begin sending data to your server when it's available, with no further requests required as a one-way data sharing mechanism. Webhook events trigger the data to be sent to your server's endpoint via a POST request. In short, webhooks make getting near real-time data changes effortless. If this sounds too complicated, you may be looking to use the Setster Zapier integration instead.

Webhook Event Triggers

Events trigger a webhook to send data to your application. For each Setster webhook, you create you can opt-in to one, multiple, or all events.

The Setster API fires webhooks for the following appointment events:

1. Add a public endpoint on your server
2. Test your new endpoint
3. Configure webhook details
4. Create Setster webhook
5. Test webhook integration

Add New Endpoint

To set up a webhook, you'll need to add a new publicly accessible endpoint to your server. Setster will send unauthenticated POST requests to this endpoint, which could be written in Ruby, PHP, Node.js, or any server-side language.

Test Your Endpoint

Test that your endpoint is public and can receive POST requests by sending a test request in your terminal or using a request client like Postman.

Configure Webhook Details

An example request body for creating a webhook is structured as follows:

{
  "company_id": 24232,
  "target_url": "",
  "events": [
    "appointment.created",
    {
    "event": "appointment.rescheduled",
    "active": 0
    }
  ],
  "active": 1
}

In this request body the target_url, company_id, and events array are required and the request must include your session_token retreived from authenticating your Setster API key.

• Register your target_url. This is the new endpoint you created on your server for Setster to POST event data to.
• Enter your company_id. Your company id is returned from the Authentication request.
• Select which events from the list of available events you'd like to be sent to your target_url and add them to the events array

See Create a Webhook for full the full webhook specification.

Once you've finished editing all of the details you'd like to add to your webhook, you're ready to make a POST request with the /createWebhook Setster endpoint. For sample request code See Create a Webhook.

Test webhook integration

To test your webhook integration, make a test appointment change in the API that would trigger the event type(s) you've added to your webhook(s).

At some point in time, you may need to change your webhook. To do so you'll need to send a PUT request to the /subscribe/{id} endpoint ensuring to update the target_url to your new server endpoint.

0 - 1 - 2 - 3 - 4 - 6 - 8 - 9 - 10 - 11 - checked in 12 - just arrived 13 - delayed

Webhooks Receive notifications with webhooks Setster offers webhooks to notify your application when an event happens within your account. Webhooks are especially useful for asynchronous events and building workflows within your application. For example, a new appointment is created and triggers a set of customer communications within your application.