/events

Last modified March 24, 2017

Webhook events

Typically events are received by server webhooks, but API calls can also be used to retrieve events. Events are either processed or unprocessed, depending on whether your webhook endpoint has acknowledged handling of the event. To learn more about acknowledging events see Webhooks.

Get multiple events

Get processed/acknowledged events

GET /events/processed

Get unprocessed events

GET /events/unprocessed

The response structure is nearly identical to the structure of Webhooks, except the reponse will include a type indicator that identifies the event type (e.g. order.canceled).

Example response
{
  "action": "events.get",
  "result": "success",
  "page": null,
  "limit": null,
  "nextPage": null,
  "total": 0,
  "events": [
    {
      "id": "_72l0mpyTemSa29zpQoMIg",
      "processed": true,
      "created": 1487897414414,
      "type": "account.created",
      "live": true,
      "data": {
        "id": "DFTDIJEKS06lBQBp31lVAw",
        "account": "DFTDIJEKS06lBQBp31lVAw",
        "contact": {
          "first": "John",
          "last": "Doe",
          "email": "jdoe@fastspring.com",
          "company": null,
          "phone": null
        },
        "language": "en",
        "country": "US",
        "lookup": {
          "global": "2-LEckNbTzi4vdskEvxM2A"
        },
        "url": "https://furiousfalcon.onfastspring.com/account"
      },
      "event": "_72l0mpyTemSa29zpQoMIg"
    },
    {
      "id": "ok2KdevXTBeG548LU8ZXWw",
      "processed": true,
      "created": 1487897415756,
      "type": "payoutEntry.created",
      "live": false,
      "data": {
        "orderId": "76OpTgwCRpGdr9_lV_Eygw",
        "reference": "FUR170224-4235-32124",
        "live": false,
        "order": "76OpTgwCRpGdr9_lV_Eygw",
        "account": "DFTDIJEKS06lBQBp31lVAw",
        "subscriptions": [],
        "subtractions": {
          "tax": {
            "currency": "USD",
            "amount": 0,
            "percentage": 0
          },
          "fastspring": {
            "currency": "USD",
            "amount": 0.8856,
            "percentage": 8.9
          }
        },
        "payouts": [
          {
            "payee": "furiousfalcon",
            "currency": "USD",
            "payout": "9.06",
            "subtotal": 9.06,
            "total": "9.95"
          }
        ]
      },
      "event": "ok2KdevXTBeG548LU8ZXWw"
    },
    {
      "id": "pJODKqWNR0CuAKsda5Ft4w",
      "processed": true,
      "created": 1487897416589,
      "type": "order.completed",
      "live": false,
      "data": {
        "order": "76OpTgwCRpGdr9_lV_Eygw",
        "id": "76OpTgwCRpGdr9_lV_Eygw",
        "reference": "FUR170224-4235-32124",
        "buyerReference": null,
        "completed": true,
        "changed": 1487897415721,
        "changedValue": 1487897415721,
        "changedInSeconds": 1487897415,
        "changedDisplay": "2/24/17",
        "language": "en",
        "live": false,
        "currency": "USD",
        "payoutCurrency": "USD",
        "invoiceUrl": "https://furiousfalcon.onfastspring.com/account/order/FUR170224-4235-32124/invoice",
        "account": "DFTDIJEKS06lBQBp31lVAw",
        "total": 9.95,
        "totalDisplay": "$9.95",
        "totalInPayoutCurrency": 9.95,
        "totalInPayoutCurrencyDisplay": "$9.95",
        "tax": 0,
        "taxDisplay": "$0.00",
        "taxInPayoutCurrency": 0,
        "taxInPayoutCurrencyDisplay": "$0.00",
        "subtotal": 9.95,
        "subtotalDisplay": "$9.95",
        "subtotalInPayoutCurrency": 9.95,
        "subtotalInPayoutCurrencyDisplay": "$9.95",
        "discount": 0,
        "discountDisplay": "$0.00",
        "discountInPayoutCurrency": 0,
        "discountInPayoutCurrencyDisplay": "$0.00",
        "discountWithTax": 0,
        "discountWithTaxDisplay": "$0.00",
        "discountWithTaxInPayoutCurrency": 0,
        "discountWithTaxInPayoutCurrencyDisplay": "$0.00",
        "billDescriptor": "FS* fsprg.com",
        "payment": {
          "type": "test",
          "cardEnding": "4242"
        },
        "customer": {
          "first": "John",
          "last": "Doe",
          "email": "jdoe@fastspring.com",
          "company": null,
          "phone": null
        },
        "address": {
          "postalCode": "93105",
          "country": "US",
          "display": "93105, US"
        },
        "notes": [],
        "items": [
          {
            "product": "falcon",
            "quantity": 1,
            "display": "Furious Falcon",
            "sku": "falcon6abc123",
            "subtotal": 9.95,
            "subtotalDisplay": "$9.95",
            "subtotalInPayoutCurrency": 9.95,
            "subtotalInPayoutCurrencyDisplay": "$9.95",
            "discount": 0,
            "discountDisplay": "$0.00",
            "discountInPayoutCurrency": 0,
            "discountInPayoutCurrencyDisplay": "$0.00",
            "fulfillments": {
              "falcon_license_0": [
                {
                  "license": "Falcon-kLeEuksTu4UZXr5fT0Xb",
                  "display": "License Key",
                  "type": "license"
                }
              ],
              "falcon_file_0": [
                {
                  "display": "Falcon.exe",
                  "size": 5769,
                  "file": "https://furiousfalcon.onfastspring.com/account/file/FUR170224-4235-14140F",
                  "type": "file"
                }
              ],
              "instructions": "<p>Thank you for purchasing <em>Falcon</em>. To register, please launch the trial version and select <strong>Help</strong> | <strong>Register Falcon</strong>. Then, copy and paste the license key above into the <strong>License Key</strong> field and click <strong>Submit</strong>.</p>"
            }
          }
        ]
      },
      "event": "pJODKqWNR0CuAKsda5Ft4w"
    }
  ],
  "more": true
}

Modifiers

  • ?days=5 - Events from last 5 days.
  • ?begin=unixtime&end=unixtime

Limited to 25 results returned. Results will contain a "more" attribute if there are more results beyond 25. To page to additional results the timestamp of the nearest event should be fed into begin / end (narrowing the timeframe).

Updating a single event

POST /events/{id}
Request Example
{
	"processed":true
}