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 Verification / Data Issuance / Data Presentation

Events of this class occur when a data is being verified, issued or presented.

• Webhook Type: CREDENTIAL_VERIFICATION

• Webhook Events:

  • CREDENTIAL_VERIFICATION_PENDING
  • CREDENTIAL_VERIFICATION_COMPLETED
  • CREDENTIAL_VERIFICATION_FAILED

• Webhook Type: CREDENTIAL_ISSUANCE

• Webhook Events:

  • CREDENTIAL_ISSUANCE_PENDING
  • CREDENTIAL_ISSUANCE_COMPLETED
  • CREDENTIAL_ISSUANCE_FAILED

• Webhook Type: CREDENTIAL_PRESENTATION

• Webhook Events:

  • CREDENTIAL_PRESENTATION_PENDING
  • CREDENTIAL_PRESENTATION_COMPLETED
  • CREDENTIAL_PRESENTATION_FAILED

Example payload:

{
  "type": "CREDENTIAL_ISSUANCE",
  "action": "CREDENTIAL_ISSUANCE",
  "event": "CREDENTIAL_ISSUANCE_COMPLETED", // CREDENTIAL_ISSUANCE_PENDING, CREDENTIAL_PRESENTATION_FAILED
  "params": {
    "didcommThreadId": "String"
    "userAccountId": "String"
  }
}

Data Status

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

• Webhook Type: SSI_AGENT
• Webhook Action: CREDENTIAL_STATUS_UPDATE
• Webhook Events:
  • CREDENTIAL_REVOKED
  • CREDENTIAL_SUSPENDED
  • CREDENTIAL_UNSUSPENDED

Example payload:

{
  "type": "SSI_AGENT",
  "action": "CREDENTIAL_STATUS_UPDATE",
  "event": "CREDENTIAL_REVOKED", // CREDENTIAL_SUSPENDED, CREDENTIAL_UNSUSPENDED
  "params": {
    "userAccountId": "String"
    "credentialId": "String"
  }
}