Skip to main content

​
Webhooks

Webhooks enable organizations to receive event notifications about their subscribed entities.

​
Supported Events:

EventDescription
alert.createdTriggered when a new alert is created.
alert.resolvedTriggered when an alert is resolved.

​
Request Headers:

HeaderTypeRequiredDescription
Content-TypestringYesSpecifies the request content type (application/json).
AuthorizationstringYesCan use Basic Authentication or custom headers.

​
Authentication Options:

  1. Basic Authentication:
  • Add Authorization: Basic <BASE64_ENCODED_CREDENTIALS>.
  1. Custom Header:
  • Use a custom header, e.g., X-API-Key: <API_KEY>.

​
Sample Webhook Request:

curl -X POST "https://your.webhook.url" \
-H "Content-Type: application/json" \
-H "Authorization: Basic BASE64_BASIC_CREDENTIALS" \
-d '{
  "event": "alert.created",
  "timestamp": "2024-11-01T00:00:00Z",
  "payload": {
            "id": "5e287b34-9c0b-430c-95ad-08a44c17de9a",
            "providerId": "1MICKEYMOUSE123",
            "provider": "ETHOCA",
            "type": "ETHOCA_CONFIRMED_FRAUD",
            "alertTimeStamp": "2015-02-27T04:33:04.328Z",
            "enrollmentId": "b52fd403-54f6-4a82-8bc5-516221115276",
            "companyId": d2599442-95fa-49bf-a0a2-086362ef2283,
            "issuer": "CARD_ISSUER",
            "cardBin": "800012",
            "cardLastFour": "1224",
            "cardExpirationDate": null,
            "acquirerBin": null,
            "status": "OPEN",
            "statusCode": null,
            "ruleType": null,
            "ruleName": null,
            "installmentNumber": null,
            "pricingTier": null,
            "transactionTimeStamp": "2015-02-28T04:33:04.328Z",
            "merchantDescriptor": "MINNIE MOUSE STORE",
            "descriptorContact": null,
            "ethocaMergantId": "{\"Merchant2\",\"98765\"}",
            "merchantId": "456789",
            "merchantOrderId": null,
            "merchantName": "ABC ONLINE",
            "partnerId": null,
            "partnerName": null,
            "clientName": null,
            "caid": null,
            "mcc": null,
            "amount": "352.99",
            "currency": "USD",
            "transactionType": "eCommerce",
            "initiatedBy": "issuer",
            "authCode": "73536582",
            "source": null,
            "reasonCode": null,
            "acquirerReferenceNumber": null,
            "transactionId": null,
            "chargebackAmount": null,
            "chargebackCurrency": null,
            "paymentType": null,
            "createdAt": "2024-12-31T09:23:14.096Z",
            "updatedAt": "2024-12-31T09:23:14.096Z",
            "outcome": null,
            "hoursLeft": 0
        }
}'