FastSpring supports server webhooks and browser scripts. You can utilize them to parse information, then update your database and trigger additional events.

Design each endpoint to handle multiple posts that contain unique event IDs for the same transaction or event. We recommend designing the script to parse duplicate posts and handle identical events. Automatic retries will have the same event ID however, manual retries will contain new IDs. Subsequent posts may contain updated information.

🚧

Webhooks may be delayed during routine batch processes, such as subscription rebills and deactivations. The webhook will enter a queue, and fire in the order it was received.

Your Store can handle several webhook events. Each event can apply to as many URLs as necessary. Each post from FastSpring to your endpoint may contain multiple webhooks in the payload.

Webhook Configuration

Set Up Webhooks

1. In the FastSpring App, navigate to Developer Tools > Webhooks> Configuration. An empty webhook container is created. You can use this for live and test orders.
2. Click Add Webhook to create additional webhook configurations.

Create a Webhook

1. Navigate to Developer Tools > Webhooks> Configuration. At the top, right corner, click Add Webhook.
2. In the Title field, add an internal-facing name for the webhook.
3. Below Get webhooks from, select whether you would like FastSpring to send you webhook events for live orders, test orders, or both.
4. Optionally, select Enable webhook expansion to use the expanded JSON data with this webhook. See Webhook Expansion for more information.
5. Click Add. Save your changes.

Add URLs and Events to the Webhook

After creating a webhook, follow the steps below to apply URLs and events to it. This enables you to send specific webhook events to multiple URLs and endpoints.

1. On the Webhooks page, navigate to the webhook you wish to edit. Click Add URL Endpoint.
2. In the URL field, enter the external URL or endpoint where you want FastSpring to post the JSON data. We recommend using HTTPS endpoints to encrypt data.
   • Webhook posts use port 8443 of the targeted endpoint unless otherwise specified. If you need to specify a different port in your URL, please use one of the following ports: 3443, 8282, 9191, 9000, 9999.
3. In the HMAC SHA256 Secret field, optionally enter a secret phrase for additional security. See Message Security for more information.
4. In the Events section, select each event that you would like FastSpring to post on the URL.
5. Click Add.

Server Webhooks

FastSpring delivers server-to-server webhook events as the POST body JSON payload to your specified URLs. Some webhooks may also trigger a customer notification.

Webhook Log Activity

View Server Webhook History

You can view the history of your configured webhook events in the Webhook Log. Navigate to Developer Tools > Webhooks > Log

The Webhook Log displays rich information for each webhook event, including:

• Webhook: Which webhook the event belongs to
• Resource ID: The order, subscription, or customer account ID and link (if available) that the event is associated with
• Event type: All server webhook event types are available in the table
• Event status: There are four event statuses (see here for more details on statuses) -
  • Not attempted
  • Failed but will be retried
  • Success
  • Permanently failed
• Attempts: Number of resend attempts made
• Last retry: Date and time of the last resend attempt (in UTC), and who made the attempt
• Creation date: Event creation date and time (in UTC)

You will also be able to view detailed information about each event by clicking on the “View” link, including the event’s JSON payload and response history.

The Log has filtering capabilities to allow you to view a subset of events that you’re interested in. You can filter by status, event type, webhook, creation date and time, and last attempted by.

The Webhook Log also gives you the ability to resend single or multiple events.

View Server Webhook Activity

You can view up to 250 of the most recent events for which you have configured webhooks. This displays the date, time, and JSON contents of each event.

1. Navigate to Developer Tools > Webhooks> ConfigurationAa.
2. Scroll to the bottom of each configured webhook. Next to Recent Activity, select All, Successful, or Failed. This will display the associated webhook activity in a modal.
3. Click FILTER to select whether the listed activity includes Processed events, Unprocessed events, or All.

👍

If you do not see recent webhook events, you can use the /events/unprocessed API endpoint to request the contents. The API response will return identical structure to the webhook events.

Request Payload Example

The following example contains 2 event types.

{
    "events": [
        {
            "id": "jazYJQw5RSWVR474tU2Obw",
            "live": true,
            "processed": false,
            "type": "subscription.activated"       
            "created": 1426560444800,
            "data": {
                .... See webhook payload examples for "data" contents ....
            }
        }
    ,   
        {
            "id": "VOe5PQx-T4S6t8yS_ziYeA",
            "live": true,
            "processed": false,
            "type": "subscription.deactivated"     
            "created": 1426560444900,
            "data": {
                .... See webhook payload examples for "data" contents ....
            }
        }
    ]
}