Skip to main content

Webhooks

Webhooks are a key element for integrating with Hellgate®, offering a convenient approach to receive real-time notifications about state changes.

Creating a Webhook​

In the Hellgate® product dashboard, under the "Webhooks" section, you can create webhooks in order to subscribe to available event types.

Create new Webhook

In our API Documentation, certain endpoints include a Callbacks section detailing the availability of webhooks.

Webhook Structure​

Each Webhook event includes the following fields:

  • id: A unique identifier for the event that triggered the notification.
  • created_at: The timestamp of when the event occurred, formatted in ISO 8601.
  • event_type: The type of event, as described below in the Events section.
  • object: The structure of the object varies depending on the event type.

Example​

{
  "id": "6a757512-44e8-44cd-ad82-f7e9da2f353a",
  "created_at": "2024-08-09T09:08:20.809661Z",
  "event_type": "token.created",
  "token": {
    "account_number_last_four": "3490",
    "account_number_length": 16,
    "authentication_data": {},
    "bank_name": "Intl Hdqtrs-Center Owned",
    "card_art_url": null,
    "cardholder_name": "John Doe",
    "country_code": "US",
    "created_at": "2024-08-09T09:08:20.798263Z",
    "expires_at": null,
    "expiry_month": 12,
    "expiry_year": 2025,
    "id": "6a757512-44e8-44cd-ad82-f7e9da2f353a",
    "identity_and_verification": "none",
    "invalidated_at": null,
    "issuer_identification_number": "46229431",
    "masked_account_number": "462294XXXXXX3490",
    "network_token_status": "pending",
    "scheme": "VISA",
    "segment": "consumer",
    "status": "active",
    "supports_device_binding": false,
    "type": "debit"
  }
}

Retry Strategy​

When Hellgate® sends a notification to your integration server, the server's response determines whether Hellgate® considers the notification successfully delivered or if it should retry.

  • HTTP 200 (OK): Hellgate® treats this as a successful delivery, and no retries will be made.
  • Any Other HTTP Code: Hellgate® considers this a failed delivery attempt and will initiate retries.

Retry Schedule: If the server responds with a code other than 200, Hellgate® will retry the notification immediately. Subsequent retries occur at intervals of 15 seconds, 30 seconds, 60 seconds, and 120 seconds, totaling 5 attempts.

note

The list of available events for subscription will expand in the near future. Please check our Changelog regularly for updates.