Supertab Webhook Event Types

This is the list of event types that we currently send.
For guidance on how to listen to these events, take a look at Svix's guide to consuming webhooks.

onetime_offering.purchasing_completed_2025-04-01

This event is sent when the purchase of a One-Time Offering is fully completed.

Example

JSON

{
  "data": {
    "id": "onetime_offering.a3c0753a-2894-5cfb-8bba-976553b9fe42",
    "items": [
      {
        "description": "First item",
        "id": "onetime_offering_item.4f2be578-a7de-7b3e-a2a2-9c34cbcc585f",
        "metadata": {
          "action": "Promotions"
        },
        "price": {
          "amount": 2.99,
          "currency": {
            "base_unit": "100",
            "code": "USD",
            "name": "US Dollar",
            "symbol": "$"
          }
        },
        "purchase": {
          "completed_at": "2025-05-05T10:39:27.408829Z",
          "description": "Onetime Offering May 2025",
          "entitlement_status": "some string",
          "id": "some string",
          "metadata": {},
          "offering_id": "some string",
          "onetime_offering_id": "some string",
          "price": {
            "amount": 2.99,
            "currency": {
              "base_unit": "100",
              "code": "USD",
              "name": "US Dollar",
              "symbol": "$"
            }
          },
          "purchased_at": "2025-05-05T10:39:27.383215Z",
          "status": "completed"
        }
      }
    ],
    "metadata": {},
    "price": {
      "amount": 2.99,
      "currency": {
        "base_unit": "100",
        "code": "USD",
        "name": "US Dollar",
        "symbol": "$"
      }
    },
    "status": "purchasing_completed"
  },
  "type": "onetime_offering.purchasing_completed_2025-04-01"
}

purchase.completed

This event is sent when a purchase is completed.

Example

JSON

{
  "data": {
    "completed_at": "2025-05-15T12:24:04.097598Z",
    "description": "1 Minute Time Pass",
    "entitlement_status": {
      "content_key": "site.02acc452-e808-428f-8c64-0a5311d142bb",
      "expires": "2025-05-15T12:25:04.074314Z",
      "has_entitlement": true,
      "recurs_at": null
    },
    "id": "purchase.bc5a1f06-07a7-46af-8907-e3a79e7d7a78",
    "metadata": {
      "title": "Test Page",
      "url": "https://www.supertab.co/"
    },
    "offering_id": "offering.39e953e5-3b82-461e-bd7d-7b0c764e5b10",
    "price": {
      "amount": 25,
      "currency": {
        "base_unit": 100,
        "code": "USD",
        "name": "US Dollar",
        "symbol": "$"
      }
    },
    "purchased_at": "2025-05-15T12:24:04.074314Z",
    "user": {
      "email": "test@supertab.co",
      "first_name": "Test",
      "id": "user.9125c850-7fe2-4350-9b6a-52fe9ea844d5",
      "last_name": "User"
    }
  },
  "type": "purchase.completed"
}

purchase.completed_2025-04-01

This event is sent when a purchase is completed

Example

JSON

{
  "data": {
    "completed_at": "2025-05-15T12:24:04.097598Z",
    "description": "1 Minute Time Pass",
    "entitlement_status": {
      "content_key": "site.02acc452-e808-428f-8c64-0a5311d142bb",
      "expires": "2025-05-15T12:25:04.074314Z",
      "has_entitlement": true,
      "recurs_at": null
    },
    "id": "purchase.bc5a1f06-07a7-46af-8907-e3a79e7d7a78",
    "metadata": {
      "title": "Test Page",
      "url": "https://www.supertab.co/"
    },
    "offering_id": "offering.39e953e5-3b82-461e-bd7d-7b0c764e5b10",
    "price": {
      "amount": 25,
      "currency": {
        "base_unit": 100,
        "code": "USD",
        "name": "US Dollar",
        "symbol": "$"
      }
    },
    "purchased_at": "2025-05-15T12:24:04.074314Z",
    "user": {
      "email": "test@supertab.co",
      "first_name": "Test",
      "id": "user.9125c850-7fe2-4350-9b6a-52fe9ea844d5",
      "last_name": "User"
    }
  },
  "type": "purchase.completed"
}