Sign in

v8

OpenAPI 3.1.02026-08-033623795.0 MB
Memberships

Membership Trial ending soon

Sent when a membership is trial ending soon

Required permissions:

  • member:basic:read
  • member:email:read
  • webhook_receive:memberships
postWebhookmembership.trial_ending_soon

Headers

webhook-idstring required

A unique identifier for this webhook request

Example:msg_xxxxxxxxxxxxxxxxxxxxxxxx
webhook-signaturestring required

The signature of the webhook request with the webhook version prepended

Example:v1,BASE64ENCODEDSIGNATURE
webhook-timestampstring required

The timestamp in seconds since the Unix epoch that the webhook was sent at on the server

Example:1727606400

Payload

api_version'v1' required

The API version for this webhook

api_version_datestring nullable required

The dated API version (Api-Version-Date) the payload is serialized to

company_idstring nullable

The account ID that this webhook event is associated with

idstring required

A unique ID for every single webhook request

timestampstring date-time required

The timestamp in ISO 8601 format that the webhook was sent at on the server

type'membership.trial_ending_soon' required

The webhook event type

Example payload

{
  "api_version": "v1",
  "api_version_date": "2026-07-20",
  "company_id": "biz_xxxxxxxxxxxxxx",
  "data": {
    "member": {
      "access_level": "no_access"
    },
    "status": "trialing"
  },
  "id": "msg_xxxxxxxxxxxxxxxxxxxxxxxx",
  "timestamp": "2025-01-01T00:00:00.000Z",
  "type": "membership.trial_ending_soon"
}

Response

Return a 200 status to indicate that the data was received successfully