Webhook Message Schema (v2)

Subscribe Pro sends webhook notifications for each of the events documented below. The schema documented here below under each event specifies data contained in the 'data' property of the webhook event request body.

The Webhook Event Request

Each webhook notification message arrives at your application (listening for HTTP messages) in the form of an HTTP web request as follows.

NOTE: The webhook_event property contains JSON encoded as string (JSON inside a JSON string).

An example webhook event request body (v2) looks like the following:

{
  "webhook_event": "{\"id\":98989898, ... \"}",
  "webhook_event_url": "//services/v2/webhook-events/98989898"
}

An example of the decoded webhook_event property looks like the following:

{
  "id": 98989898,
  "type": "payment_profile.created",
  "data": "{\"customer_id\":9898989,\"payment_profile_id\":989898,\"customer\":{\"id\":9898989, ... }}",
  "destinations": [
    {
      "id": 9191919191,
      "endpoint": {
        "id": 91919191,
        "channel": "url",
        "status": "enabled",
        "all_subscribed_event_types": false,
        "subscribed_event_types": "{\"3\":\"payment_profile.created\",\"4\":\"payment_profile.updated\",\"5\":\"payment_profile.redacted\"}",
        "created": "2020-06-04T12:24:44+0000",
        "updated": "2020-06-04T12:24:49+0000"
      },
      "status": "delivered",
      "last_attempt": "2020-07-19T15:29:23+0000"
    }
  ],
  "created": "2020-07-19T15:29:21+0000",
  "updated": "2020-07-19T15:29:21+0000"
}

NOTE: The data property contains JSON encoded as string (JSON inside a JSON string). Yes, this is double encoded as JSON inside JSON string because the data property is inside the webhook_event property.

An example of the decoded data property looks like the following:

{
  "customer_id":9898989,
  "payment_profile_id":989898,
  "customer":{
    "id":9898989,
    ...
    "created":"2020-07-19T15:29:11+0000",
    "updated":"2020-07-19T15:29:11+0000",
    "subscription_count":0,
    "active_subscription_count":0,
    "trial_subscription_count":0,
    "active_subscribed_qty":0
  },
  "payment_profile":{
    "id":989898,
    "customer_id":9898989,
    ...
    "billing_address":{
      ...
      "created":"2020-07-19T15:29:21+0000",
      "updated":"2020-07-19T15:29:21+0000"
    },
    "created":"2020-07-19T15:29:21+0000",
    "updated":"2020-07-19T15:29:21+0000"
  }
}

All Webhook Event Types

Customer Event Types

Event	Type code
Customer Subscribed	`customer.subscribed`
Customer Cancelled	`customer.cancelled`

Payment Profile Event Types

Event	Type code
Payment Profile Created	`payment_profile.created`
Payment Profile Updated	`payment_profile.updated`
Payment Profile Redacted	`payment_profile.redacted`

Subscription Event Types

Event	Type code
Subscription Created	`subscription.created`
Subscription Updated	`subscription.updated`
Subscription Cancelled	`subscription.cancelled`
Subscription Status Changed	`subscription.status_change`
Subscription Trial Converted	`subscription.trial.converted`
Subscription Email Triggered	`subscription.email`

Group Subscription Event Types

Event	Type code
Group Subscription Created	`group_subscription.created`
Group Subscription Updated	`group_subscription.updated`

Customer Events

Customer Subscribed Event

Event type: customer.subscribed

Notification is sent when a customer subscribes. This means the customer previously had 0 Active subscriptions and at least 1 Active subscription has just been added.