How to Subscribe
How to Subscribe
Webhook subscriptions are managed by the brand, via the self-service webhooks tool within Dashboard. This enables brands to easily manage webhook settings so that Olo sends the right events to the Developer Partner or In-house development team.
To ensure the brand is able to create the webhook successfully, Developer Partners and In-house development teams should follow these steps:
Webhook subscriptions are managed by the brand, via the self-service webhooks tool within Dashboard. This enables brands to easily manage webhook settings so that Olo sends the right events to the Developer Partner or In-house development team.
To ensure the brand is able to create the webhook successfully, Developer Partners and In-house development teams should follow these steps:
- Configure the Destination URL. This is the single HTTPS endpoint to which webhook event data should be
POST
ed. Note, plain HTTP and ports other than 443 are not supported. - Ensure your webhook consumer service is ready to receive and respond to the Test Event with an HTTP 200 response. The brand will not be able to complete the webhook configuration process without a successful response from the Test Event webhook.
- Provide the brand with the Destination URL.
- If your integration is using OAuth for webhook authorization, also provide the brand with the Authorization URL, Client Id, Client Secret, and Authorization Scope (if required).
Olo requires the token to be valid for at least 1 hour (3600 seconds).
expires_in
field must be populated with the token lifetime in seconds. See 4.2.2. Access Token Response for more information. - During the webhook creation process, the brand will be prompted to provide you with a 64-character shared secret. This value is used to calculate the X-Olo-Signature header and may be used to verify messages were sent from Olo.
- Once the webhook has been published by the brand, you will start to receive webhook event messages. Reference At-Least Once Delivery for further details about message delivery.
Questions about this process? Reach out to Developer Support (developersupport@olo.com). We're here to help!
The events you subscribe to must all be sent to the same Destination URL, and that only one webhook is allowed per environment for each approved brand (or per Rails partner). A different Destination URL can be provided for different brands, but not for different events from the same brand.
To Find your Key, ClientID, and Client Secret:
Once you have confirmed your Project has been set up in your OLO developer portal, you will be able to get your Key, ClientID and Client Secret for delightable:
- Log into your Developer Portal
- Click Projects
- Click on the name of the Project in your Developer Portal
- Retrieve your Vendor ID
Mapping OLO Key, ClientID, and Client Secret to Delightable Stores
- Log into app.delightable.com
- Click Settings
- Click OLO tile
- Enter in a name that makes sense to you for the Connection. We recommend as a best practice ["Brand Name" OLO] to keep it simple and straightforward.
- Enter in Vendor ID
- Click Add
Congrats! You have connected this data source! Repeat for any additional brands you may be connecting.