Notifications

Once you've successfully set up subscriptions, Showpad pushes the relevant notification in an HTTP request to your specified URL endpoint.

TL;DR

• Payload format: JSON with an outer event object and inner data object(s)
• Event object: Contains type, specversion, id, and time
• Data object: Contains event-specific details (varies by event type)

What you'll learn

• The structure of webhook notification payloads
• What information is included in the event object
• How data objects vary by event type

The structure of the notification payload is the same no matter the event you've subscribed to. You can review the Payload Reference to view a description and example of each item included in a notification.

Upon receiving notifications, the HTTP status code returned to Showpad determines what happens next.

Payload Structure

The payload is sent in standard JSON format and consists of an outer event object and one or more inner data objects with the relevant event data.

Event object

The outer event object contains the following information:

Information	Data Type	Description
type	string	The event type.
specversion	string	The schema version of the event.
id	string	The event's Showpad identifier.
time	string (date time)	The date and time of the event.

Data objects

The inner data object(s) contains the details of the event that triggered the webhook. The content of the data object(s) varies depending on the type of event.

Example

{
  "type": "shared-space-user-added",
  "specversion": 1,
  "id": "c40b30f2-fabf-4c89-aed0-f5f5aaac9a24",
  "time": "2022-15-30T06:45:00.250Z",
  "data": {
    "inviter": {
      "userId": "d40cce9cdc0945298b8120ca7de4adc7",
      "shareActorId": "e3dff281ad48421fb32de1cbab3a627f",
      "email": "chris.p.bacon@showpad.com"
    },
    "invitee": {
      "userId": "8463e2b6c0c44715b20b2fd65201bfae",
      "shareActorId": "f4ce56f640d94e8490d7ee3bf2d41784",
      "email": "kent.cook@showpad.com"
    },
    "sharedSpace": {
      "id": "14aade8219854ed5b096b759e036e646",
      "name": "Breakfast Service"
    }
  }
}

Next steps

• Verify webhook signatures to secure your endpoint
• View all event schemas in the Payload Reference