Overview

With Firespring's webhooks, you can be notified anytime certain events happen on your website. You just tell us the URL to post the information to and we'll deliver the data when each respective event occurs.

The webhook data will be sent as soon as possible, but we make no guarantees about delivery time. You can use our API to request data on your own schedule if you prefer.

All webhooks contain the following keys:

Key	Description
`id`	A unique, numeric, identifier for the webhook. You can use this value to record which webhooks you've already seen, recorded, or acted on.
`object`	String representing the object's type. Objects of the same type share the same value.
`date_created`	The ISO-8061 date when the event was triggered.
`event_type`	An identifier for the type of event that occurred.
`payload`	Data about the event triggered. The data included will be unique for each event type.
`version`	A version string for the request being sent.

Receiving Webhooks

Webhook data is sent as JSON. Basic information is included in the request's body, but additional information is available from the Firespring API. If the data integrity is critical or you want to confirm the information is from Firespring, you can use the ID from the webhook and pull the rest of the data manually through the Firespring API.

It's a good idea to log which IDs you receive to protect yourself from replay-attacks and prevent accepting the same request twice.

Once you've received a webhook, you should acknowledge its receipt by replying with a 200 response as soon as possible. If we have not received a 200 response within 30 seconds, we will try resending the information based on a backoff schedule. This schedule will send a follow up attempt 1 minute later, then 2 minutes, 4 minutes, 8 minutes, etc., until 3 total days have passed. Once the 3 day limit as been reached, no further attempts will be made.

Configuring Webhooks

You can configure your webhooks in the Springboard under My Website > Website Settings.