Basic Usage

To begin receiving real-time events from the Sparkfly platform, you'll need to set up a callback listener and create the necessary subscriptions.

Develop a Callback Listener

Develop an HTTP endpoint that can receive and process incoming event notifications. Ensure that your listener can handle POST requests and verify the HMAC signatures as described in the Callbacks section.

Create a Callback in Sparkfly

Create a callback using the Events API: Create a new callback endpoint.

Provide the URL of your callback listener. Store the signing_key returned in the response, as you'll need it to verify incoming event notifications.

Subscribe to Events

Using the callback_id from the previous step, create subscriptions for the events you want to receive using the Events API: Create a new subscription endpoint.

That's it! Once you've completed these steps, your callback listener will start receiving real-time event notifications from the Sparkfly platform as they occur.

Next Steps

Callbacks and subscriptions can be managed using the Events API.

Refer to the Events API Reference for detailed information on available endpoints and operations.