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:

Event Type	Description
`assignmentCreated.challenge` `assignmentCompleted.challenge` `assignmentProgress.challenge`	A Challenge assignment has been created/completed/updated for a user. See Challenge Assignment for details.
`assignmentCreated.guide` `assignmentCompleted.guide` `assignmentProgress.guide`	A Guide assignment has been created/completed/updated for a user. See Course/Guide Assignment for details.
`assignmentCreated.path` `assignmentCompleted.path` `assignmentProgress.path`	A Path assignment has been created/completed/updated for a user. See Path/Training Series Assignment for details.
`assignmentCreated.resource` `assignmentCompleted.resource`	A Resource assignment has been created/completed for a user. See Resource Assignment for details.
`assignmentCreated.scorm` `assignmentCompleted.scorm` `assignmentProgress.scorm`	A SCORM assignment has been created/completed/updated for a user. See SCORM Assignment for details.
`eventSession.attendee.created` `eventSession.attendee.statusChanged` `eventSession.attendee.deleted`	An Event Session Attendee has been created/updated/deleted for a user. See Event Session Attendee for details.
`userCreated`	A user has been created.
`userDeleted`	A user has been deleted.

Common Event Properties

Each event payload always contains the following fields:

Field	Type	Description
`eventType`	string	type of the event
`timestamp`	integer	timestamp when the event occurred
`user`	object	the user this event is for (see:The `user` object)

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

Common payload:

{
  "eventType": "<event type>",
  "timestamp": 1726510395258,
  "user": {
    "id": 1,
    "name": "Example User",
    "email": "[email protected]",
    "isAdmin": true,
    "isDeleted": false,
    "isPermanentlyDeleted": false,
    "createdAt": 1726510395258,
    "updatedAt": 1726510395258,
    "groups": [
      {
        "id": 1,
        "name": "Ninjas"
      }
    ],
    "customAttributes": [
      {
        "id": 1,
        "apiName": "example_attribute",
        "value": "something"
      }
    ],
    "userIdentifiers": [
      {
        "identifier": "0e8d3dcfe9c9e4c0b7d351f1e14e878b",
        "namespace": "sso_scim"
      }
    ],
    "managers": [
      {
        "id": 3,
        "name": "Manager 2",
        "email": "[email protected]"
      },
      {
        "id": 2,
        "name": "Manager 1",
        "email": "[email protected]"
      }
    ]
  }
}