Aptem Webhooks: Tracker type

Entity: Tracker

This webhook sends notifications when Aptem trackers are created or updated, regardless of tracker type.

The payload for a Tracker webhook includes:

  • id

  • userId

    • a Learner / Participant Id the tracker is created for

  • notes

  • type

  • status

  • description

  • AND event (“update” or “create”)

 

Create event

For the Create event type, the webhook is sent when a new tracker is created in the tenant.

Payload

The payload for Create event type includes “event”:”create” field.

Example: 

{
  "id": 1,
  "userId": 8,
  "notes": null,
  "type": "ILR",
  "status": "New",
  "description": "This is a description for the tracker: please update accordingly",
  "event": "create"
}

 

Update event

For the Update event type, the webhook is sent when any field of an existing tracker is updated, or when a tracker is re-saved without any changes.

Note: The webhook only reflects changes to fields included in the payload. For example, if the assignee of a tracker is updated, the webhook will still be sent, but the payload will not include details of the assignee change.

Payload

The payload for Update event type includes “event”:”update” field.

Example: 

{
  "id": 1,
  "userId": 8,
  "notes": "Please be mindful about timings.",
  "type": "ILR",
  "status": "Closed",
  "description": "This is a description for the tracker: please update accordingly",
  "event": "update"
}

 

Delete event

For DELETE event type, the Webhook is not supported.

Was this article helpful?
0 out of 0 found this helpful