A webhook (also called a web callback or HTTP push API) is a way for Spike to provide your application with real-time information. A webhook delivers notifications to your applications as new event happens, meaning you get notified immediately - unlike a typical API where you would need to poll for data very frequently to get it in real-time. This makes webhooks much more efficient for the provider and consumer. New incoming data will be normalized and notitifation about is sent to your webhook URL address.

The endpoint you create must be configured to accept POST requests. It has to be an HTTPS-secured endpoint on your server with a distinct URL. You can enable webhook messages by configuring your webhook URL address in your app settings page in the developer console. Removing this URL will result in webhooks being disabled.

All Spike webhook events have the following structure in JSON format. In the example below you will find the base JSON object for a webhook payload. Right now "event_type": "record_change" is the only one supported and it indicates that particular metrics (listed) or activity_types such as workouts or sleep sessions were recorded by application_user_id at particular dates. If your application based on your individual use case is interested to receive this data, you should poll for it using the query APIs or SDKs used.