Introduction to Webhooks

Webhooks enable you to integrate WorkRamp user events with your existing systems. When specific events occur, we will POST event data to an endpoint that you provide.

Event Types

The following event types are currently supported:


`userRegistration`	Contact has registered. Contains no added fields.
`contentEnrollment.certification`	Contact has enrolled (or been enrolled) in a Certification. Contains an extra `certification` field, see below. NOTE: this event will not trigger immediately if a Contact starts a Certification without an invite, this may change in the future
`contentCompletion.certification`	Contact has completed a Certification. Contains an extra `certification` field, see below.
`contentEnrollment.guide`	Contact has enrolled (or been enrolled) in a Guide. Contains an extra `guide` field, see below.
`contentCompletion.guide`	Contact has completed a Guide. Contains an extra `guide` field, see below.
`contentEnrollment.path`	Contact has enrolled (or been enrolled) in a Path. Contains an extra `path` field, see below. NOTE: this event will not trigger immediately if a user starts a Path without an invite, this may change in the future
`contentCompletion.path`	Contact has completed a Path. Contains an extra `path` field, see below.
`contentEnrolmment.resource`	Contact has enrolled (or been enrolled) in a Resource. Contains an extra `resource` field, see below.
`contentCompletion.resource`	Contact has completed a Resource. Contains an extra `resource` field, see below.
`contentEnrollment.scorm`	Contact has enrolled (or been enrolled) in a SCORM training. Contains an extra `scorm` field, see below.
`contentCompletion.scorm`	Contact has completed a SCORM training. Contains an extra `scorm` field, see below.

Common Event Properties

Each event payload always contains the following fields:


`eventType`	type of the event
`id`	(content events only) unique identifier of the Assignment
`timestamp`	timestamp for when the event occurred
`user`	object describing the user this event is for:
`user.id`	unique identifier of the Contact
`user.email`	email address of the Contact
`user.firstName`	first name of the Contact
`user.lastName`	last name of the Contact
`user.customAttributes`	object containing all custom attributes for this user in `"attributeName": "attributeValue"` format

📘
Timestamps
Timestamps are UNIX-style with milliseconds, eg 1675816954321 is Wed Feb 08 2023 00:42:34 GMT+0000

Common payload:

{
  "eventType": "<event type>",
  "id": "b74a95c5-a011-4fb2-aa55-e01074bbf2f8",
  "timestamp": 1675816954321,
  "user": {
    "id": "86090baa-a643-11ed-9492-aa41bb3ba07e",
    "email": "[email protected]",
    "firstName": "Example",
    "lastName": "User",
    "customAttributes": {
      "department": "Sales"
    }
  }
}

Certification Object Properties


`id`	unique identifier of the Certification
`name`	name of the Certification
`url`	URL of the Certification
`contentCompletion.certification`:
`certificate`	object describing the user's Certificate
`certificate.id`	unique identifier of the Certificate
`certificate.expiresAt`	timestamp for when the Certificate expires (currently always `null`)
`certificate.issuedAt`	timestamp for when the Certificate was issued
`certificate.validateUrl`	URL of the Certificate

Enrollment payload example:

{
  <common fields>
  "certification": {
    "id": "1088f228-a747-11ed-b200-aa41bb3ba07e",
    "name": "Certification Example",
    "url": "https://example.workramp.local/certifications/1088f228-a747-11ed-b200-aa41bb3ba07e"
  }
}

Completion payload example:

{
  <common fields>
  "certification": {
    "id": "1088f228-a747-11ed-b200-aa41bb3ba07e",
    "name": "Certification Example",
    "url": "https://example.workramp.local/certifications/1088f228-a747-11ed-b200-aa41bb3ba07e",
    "certificate": {
      "id": "INsybEXiUg",
      "expiresAt": null,
      "issuedAt": 1675816954321,
      "validateUrl": "https://example.workramp.local/certificate/INsybEXiUg"
    }
  }
}

Guide Event Properties


`id`	unique identifier of the Guide
`name`	name of the Guide
`url`	URL of the Guide

Payload example:

{
  <common fields>
  "guide": {
    "id": "1088f228-a747-11ed-b200-aa41bb3ba07e",
    "name": "Guide Example",
    "url": "https://example.workramp.local/guides/1088f228-a747-11ed-b200-aa41bb3ba07e",
  }
}

Path Event Properties


`id`	unique identifier of the Path
`name`	name of the Path
`url`	URL of the Path

Payload example:

{
  <common fields>
  "path": {
    "id": "1088f228-a747-11ed-b200-aa41bb3ba07e",
    "name": "Path Example",
    "url": "https://example.workramp.local/paths/1088f228-a747-11ed-b200-aa41bb3ba07e",
  }
}

SCORM Event Properties


`id`	unique identifier of the SCORM content
`name`	name of the SCORM content
`url`	URL of the SCORM content

Payload example:

{
  <common fields>
  "scorm": {
    "id": "1088f228-a747-11ed-b200-aa41bb3ba07e",
    "name": "SCORM Example",
    "url": "https://example.workramp.local/scorm/1088f228-a747-11ed-b200-aa41bb3ba07e",
  }
}

Resource Event Properties


`id`	unique identifier of the Resource
`name`	name of the Resource
`url`	URL of the Resource

Payload example:

{
  <common fields>
  "resource": {
    "id": "1088f228-a747-11ed-b200-aa41bb3ba07e",
    "name": "Resource Example",
    "url": "https://example.workramp.local/resources/1088f228-a747-11ed-b200-aa41bb3ba07e"
  }
}