Store Purchase Webhook (Legacy)

This webhook is only available to legacy enterprise clients

Triggered when a user makes a purchase in the Synap store. - Please note the Synap store is no longer offered on non Enterprise plans

To subscribe to this webhook, please set up a URL endpoint capable of receiving POST requests.

Request Details

The request will POST a JSON payload that conforms to the following Typescript interface:

interface StorePurchaseWebhookBody {
  user: {
    id: string;
    name: string;
    email: string;
  };
  portal: {
    id: string;
  };
  objectId: string;
  title: string;
  unlockActions: {
    type: string;
    targetId: string;
  }[];
  purchaseMethod: string;
  shortDescription: string;
  purchasedAt: string;
}