Implement your own system for sending event data to Swell
Overview
The Events API is an Enterprise feature, which means it's applicable to larger customers who are typically managing multiple brands or business entities within Swell.
Enterprise customers can integrate directly with Swell by sending appointment event data to the Events API, where it can trigger automations configured in the Swell platform.
Here's a brief summary of the steps involved in integrating with the Events API:
- Determine which data you will need to send and how frequently (e.g. realtime, hourly batches).
- Provision client credentials for your organization using the steps outlined below.
- Design and implement a custom application that posts your event data to the Events API.
- Configure your connection by mapping brands in your data to your brands in Swell.
- Configure automations to send review invites, surveys, and other messages based on the appointment data you send.
Technical information
Technical details about authentication and required data fields are available in the Events API documentation.
Create and manage client credentials for the Events API
To send data to the Events API, you'll need client credentials, which your integration will use to obtain access tokens that authenticate your requests. See more technical details about authentication in our API docs.
To create client credentials for your Enterprise account:
- Log on to https://platform.swellcx.com/ and navigate to Settings > Integration Settings > API Credentials.
- Select New API Client Credentials and create a name for your credentials.
- Save your Client ID and Client Secret in a safe place.
Please note that the Client Secret is only displayed once during credential creation and cannot be recovered in in the future.
If your credentials are lost, compromised, or need to be rotated, you can delete them and create a new set at any time. Only one set of credentials is supported at a time.
Additional notes:
- Client credentials for the Events API are automatically scoped to include all brands and locations within the Enterprise account, even if these change over time.
- Any Enterprise admin user can create/delete credentials on behalf of the entire account; they are not tied to a specific user or login.