Use incoming webhooks to get real-time updates
Listen for events on your Stretch account so your integration can automatically trigger reactions.
Stretch API uses webhooks to notify your application when an event happens in your accounts. Webhooks are particularly useful for asynchronous events like when a customer’s confirms a session or change schedules,
Note Ready to go live? Register your webhook endpoint on the Dashboard knows where to deliver events.
How Stretch API uses webhooks
A webhook enables Stretch to push real-time notifications to your app. Stretch uses HTTPS to send these notifications to your app as a JSON payload. You can then use these notifications to execute actions in your backend systems. To learn more, see Stretch webhook events overview.
The Webhooks API uses the HTTP protocol, so it works with any language that has an HTTP library. Requests use standard HTTP verbs such as GET, POST, and DELETE. All endpoints accept and return JSON. The API documentation uses the JSON data types defined by W3Schools. The resource documentation describes requests and responses in detail for each endpoint.
Getting Started
- Go to our developer portal and create your developer account.
- While logged into your developer account, request to go live with your developer account. Make sure you are logged in before you click this link.
- While logged into your developer account, go to the Webhook section on the Developer page of your developer portal account, and create an Webhook"
- Select event subscription which you want.
- Setup webhook URL and verify
- Activate webhooks.
- Optionally, you can disable or delete your webhooks.
Webhook Events by object
Stretch API events are our way of letting you know when something interesting happens in your account. When an interesting event occurs, we create a new Event object in your account. To determine which events to use in a webhooks integration, use the steps on this page to stream events as you call Stretch APIs.
| Object | Subscription list | Return object | Description |
|---|---|---|---|
| user | signup, signin, update, delete, feedback | user | Any manipulations with account data |
| location | create, update, delete, set default | address | Create or change location |
| availability | create, update, delete | availability | Description |
| service | create, update, delete, set default | address | Create or change service data |
| session | create, update, delete, change status | session | Create or change session and notification events: created, pendig, approved, upcoming, completed, canceled, declined, disputed, refunded |
| payment | create, cancel, change status | payment | Create or canceled payment and notification events: awaiting, reciewed, failed, refund, delivered |
See also Web integrations