HEARTLAND_CREDENTIALS_RECEIVED Event

This webhook event is sent when payment processing credentials from Heartland (or other payment processors) have been received and are available for use. This typically occurs as part of the account provisioning workflow.

When This Event Is Sent

• Heartland payment processing credentials are received from the provider

Decrypted Data Parameters

This event includes all default parameter for version 1.0 in the decrypted data parameter. There is no extra information provided currently.

Example Payload

Note: This example shows the decrypted payload. When you receive this webhook, the data field will be encrypted. See the encryption reminder for details.

{
  "id": "wh_5f9NG3b4k5DWvgqwWJYxYz",
  "event_type": "HEARTLAND_CREDENTIALS_RECEIVED",
  "timestamp": "2026-03-18T22:13:36Z",
  "account_id": "account_id",
  "schema_version": "2025-11-21",
  "key_id": "whk_20260318_03",
  "data": {
    "version": "1.0",
    "subject_record_id": "sr_2dkK9FIcyDxkxsd0BeB4MU",
    "workflow_id": "w_6QRPfTUhHICQADJK7NlvFW",
    "workflow_type": "BUSINESS_APPLICATION",
    "user_context": {
      "user_id": "SYSTEM",
      "user_type": "SYSTEM"
    }
  }
}

Security Considerations

Important: This webhook notification confirms that credentials are available but does not contain the actual credentials for security reasons. You must retrieve credentials through authenticated API calls.