🏁 Get Started
Register Webhooks

Webhooks

You can leverage Portabl webhooks to help you receive important events about user data changes. We’ll send a POST request to the URL you define with details about the subscribed event type.

Webhooks can be managed from the Portabl Console here (opens in a new tab).

Event classes

Data Pipe

Events of this class occur when a secure data pipe is being established between you and your users.

  • Webhook Type: SSI_AGENT
  • Webhook Action: DATA_PIPE_STATUS_UPDATE
  • Webhook Events:
    • DATA_PIPE_INITIATED
    • DATA_PIPE_ESTABLISHED

Example payload:

{
  "type": "SSI_AGENT",
  "action": "SESSION_STATUS_UPDATE",
  "event": "SESSION_INVITE_CREATED", // SESSION_ESTABLISHED
  "params": {
    "thid": "String",
    "userId": "String"
  }
}

Data Sync

Events of this class occur when a data synchronization is being processed.

  • Webhook Type: DATA_SYNC
  • Webhook Events:
    • DATA_SYNC_NOT_STARTED
    • DATA_SYNC_STARTED
    • DATA_SYNC_COMPLETED
    • DATA_SYNC_ABORTED
    • DATA_SYNC_FAILED

Example payload:

{
  "type": "DATA_SYNC",
  "action": "DATA_SYNC",
  "event": "DATA_SYNC_NOT_STARTED", // DATA_SYNC_STARTED, DATA_SYNC_COMPLETED, DATA_SYNC_ABORTED, DATA_SYNC_FAILED
  "params": {
    "cptyDID": "String"
    "dataSyncOperationId": "String"
  }
}

Data Update

Events of this class occur when a data update is being processed.

  • Webhook Type: DATA_UPDATE
  • Webhook Events:
    • DATA_UPDATE_STARTED
    • DATA_UPDATE_COMPLETED
    • DATA_UPDATE_FAILED

Example payload:

{
  "type": "DATA_UPDATE",
  "action": "DATA_UPDATE",
  "event": "DATA_UPDATE_STARTED", // DATA_UPDATE_COMPLETED, DATA_UPDATE_FAILED
  "params": {
    "cptyDID": "String"
    "dataUpdateOperationId": "String"
  }
}

Data Status

Events of this class occur when the status of the data has changed.

  • Webhook Type: SSI_AGENT
  • Webhook Action: DATA_STATUS_UPDATE
  • Webhook Events:
    • DATA_REINSTATED
    • DATA_SUSPENDED
    • DATA_REVOKED

Example payload:

{
  "type": "SSI_AGENT",
  "action": "DATA_STATUS_UPDATE",
  "event": "DATA_REINSTATEED", // DATA_SUSPENDED, DATA_REVOKED
  "params": {
    "userId": "String"
    "credentialId": "String"
  }
}
Configure your Data ProfileIntegrate Data Sync