Skip to main content

​
Overview

Webhook payloads for Identity endpoints within the Transcrypts API.

​
Identity Profile Created

Event Type: profile-created These webhooks are triggered when successfully creating an identity and profile. The event occurs once per Link for each non-refresh Task completion, with multiple responses available when additional employments are discovered.

​
Example Payload

{
  "webhook_id": "81e4552a215d4f4695bc6fae2675aeee",
  "task_id": "c32fb957ec7246828da56be7516da765",
  "link_id": "9915c50cc047413bb810767f218390f8",
  "product": "employment",
  "data_source": "payroll",
  "tracking_info": null,
  "event_type": "profile-created",
  "event_created_at": "2022-08-23T17:32:19.295569Z",
  "object_id": "25d588c7cc1c43178375bdc1bc9852ac",
  "template_id": null
}

​
Identity Profile Updated

Event Type: profile-updated Transcrypts sends these webhooks for identity and profile data following completion of refresh Tasks.

​
Example Payload

{
  "webhook_id": "81e4552a215d4f4695bc6fae2675aeee",
  "task_id": "c32fb957ec7246828da56be7516da765",
  "link_id": "9915c50cc047413bb810767f218390f8",
  "product": "employment",
  "data_source": "payroll",
  "tracking_info": null,
  "event_type": "profile-updated",
  "event_created_at": "2022-08-23T17:32:19.295569Z",
  "object_id": "25d588c7cc1c43178375bdc1bc9852ac",
  "template_id": null
}

​
Payload Field Descriptions

FieldDescription
webhook_idUnique identifier for the webhook event
task_idAssociated Task identifier
link_idAssociated Link identifier
productData product type (employment)
data_sourceSource of the data (payroll)
tracking_infoOptional tracking information
event_typeType of event triggered
event_created_atISO timestamp of event creation
object_idUnique identifier for the profile object
template_idOptional customization template identifier