Credential Event

Webhook triggered when a credential (consent, form, signature, or JSON) is completed or rejected

Overview

The credential event is triggered when a credential is completed or rejected. The event includes credential-specific information and metadata that varies based on the credential type.

Example Payload

{
  "eventType": "credential",
  "issuerId": "680a65a4da4a16c0ea64face",
  "requestId": "68c42ec3e47c9a7f9241e0ba",
  "subjectId": "68c42ec3e47c9a7f9241e0bb",
  "subjectInternalId": "user_98765",
  "rejected": false,
  "decisionDate": "2024-01-15T18:30:00.000Z",
  "credentialId": "cred_abc123def456",
  "credentialType": "consent",
  "internalId": "privacy_consent_001",
  "metadata": {
    "name": "Privacy Policy Agreement",
    "text": "I agree to the collection and processing of my personal data.",
    "required": true,
    "link": "https://example.com/privacy-policy"
  }
}

Base Fields

All credential events include these common fields:

Field	Type	Required	Description
eventType	string	Yes	Always "credential"
issuerId	string	Yes	Organization/issuer identifier
requestId	string	Yes	Request identifier
subjectId	string	Yes	Subject (user) identifier
subjectInternalId	string	No	Internal subject identifier
rejected	boolean	Yes	Whether the credential was rejected
decisionDate	Date	Yes	Timestamp when the credential decision was made

Credential-Specific Fields

Field	Type	Required	Description
credentialId	string	Yes	Unique identifier for the credential
credentialType	string	Yes	Type of credential (see types below)
internalId	string	No	Internal identifier for the credential
metadata	object	No	Metadata specific to the credential type

Credential Types & Metadata

The metadata structure depends on the credentialType:

Consent Event

When credentialType is "consent", metadata follows the ConsentEvent structure:

{
  "name": "Privacy Policy Agreement",
  "text": "I agree to the collection and processing of my personal data.",
  "required": true,
  "link": "https://example.com/privacy-policy"
}

Field	Type	Required	Description
name	string	Yes	Name of the consent
text	string	Yes	Consent text displayed to the user
required	boolean	Yes	Whether consent is required
link	string	No	URL to the full consent document

Signature Event

When credentialType is "signature", metadata follows the SignatureEvent structure:

{
  "name": "Contract Signature",
  "url": "https://example.com/document.pdf",
  "required": true
}

Field	Type	Required	Description
name	string	Yes	Name of the signature
url	string	Yes	URL to download the signed document via API
required	boolean	Yes	Whether signature is required

Form Event

When credentialType is "form", metadata follows the FormEvent structure:

{
  "name": "User Registration Form",
  "data": {
    "firstName": "John",
    "lastName": "Doe",
    "email": "[e-mail]"
  }
}

Field	Type	Required	Description
name	string	Yes	Name of the form
data	Record<string, any>	Yes	Form field data as key-value pairs

JSON Event

When credentialType is "json", metadata follows the JsonEvent structure:

{
  "name": "Custom Data",
  "data": {
    "customField1": "value1",
    "customField2": 123,
    "customField3": true
  }
}

Field	Type	Required	Description
name	string	Yes	Name of the JSON data
data	Record<string, any>	Yes	JSON data as key-value pairs