Setting up Webhooks

Listen for events on your Uplift account so your integration can automatically trigger reactions.

Jonathan Wills avatar
Written by Jonathan Wills
Updated over a week ago

Uplift uses webhooks to notify your application when an event happens in your account. Webhooks are particularly useful for asynchronous events like when an athlete's captures are processed and kinematic data is ready to be consumed.

How Uplift uses webhooks

A webhook enables Uplift to push real-time notifications to your app. Uplift 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.

Steps to receive webhooks

You can start receiving event notifications in your app using the steps in this section:

  1. Identify the events you want to monitor and the event payloads to parse.

  2. Create a webhook endpoint as an HTTPS endpoint (URL) on your server.

  3. Handle requests from Uplift by parsing each event object and returning 2xx response status codes.

  4. Register your publicly accessible HTTPS URL in the Uplift dashboard.

How to create a webhook endpoint

Creating a webhook endpoint is no different from creating any other page on your website. It’s an HTTP or HTTPS endpoint on your server with a URL. If you’re still developing your endpoint on your local machine, it can be HTTP. After it’s publicly accessible, it must be HTTPS. You can use one endpoint to handle several different event types at once, or set up individual endpoints for specific events.

Built-in retries

Uplift webhooks have built-in retry methods for 3xx, 4xx, or 5xx response status codes. If Uplift doesn’t quickly receive a 2xx response status code for an event, we mark the event as failed and stop trying to send it to your endpoint. After multiple days, we email you about the misconfigured endpoint, and automatically disable it soon after if you haven’t addressed it.

Secure your webhooks (recommended)

Use webhook secrets to verify that Uplift generated a webhook request and that it didn’t come from a server acting like Uplift.

Webhook notifications

The full list of IP addresses that webhook notifications may come from is:
Did this answer your question?