On This Page

REST
 Example: Subscribing to a Webhook

There are additional requirements for implementing webhooks that are not discussed in this guide. For more information, see the for the REST API.
Request
{​​​
  "name": "My Custom Webhook",
  "description": "Sample Webhook from Developer Center",
  "organizationId": "organizationId",
  "productId": "
alternativePaymentMethods
",
  "eventTypes": [
      "
payments.payments.updated
"
  ],
  "webhookUrl": "https://MyWebhookServer.com:8443/simulateClient",
  "healthCheckUrl": "https://MyWebhookServer.com:8443/simulateClientHealthCheck",
  "notificationScope": "SELF",
  "retryPolicy": {​​​​​​​​​​
      "algorithm": "ARITHMETIC",
      "firstRetry": 1,
      "interval": 1,
      "numberOfRetries": 3,
      "deactivateFlag": "false",
      "repeatSequenceCount": 0,
      "repeatSequenceWaitTime": 0
  }​​​​​​​​​​,
  "securityPolicy": {​​​​​​​​​​
      "securityType": "KEY",
      "proxyType": "external"
      }​​​​​​​​​​
  }​​​​​​​​​​
Encrypted Response to Successful Request
{​​
  "eventType": "payments.payments.updated",
  "productId": "alternativePaymentMethods",
  "organizationId": "organizationId",
  "transactionTraceId": "6584251287300178228949",
  "payload": "{​​​​​​​​​CBC}​​​​​​​​​​​​​​​​nL1LK67IH1LQKad3qyhilPoeDGrHo/6ClIZ17HSC5YX9TQFIgCOhVPi139kmB/xiVCALGdU8YjqmOEwo3iUXKy6oq517eDiTHv/Crq0pOiEzs0dtuTvYhriXrpvQCF+XxqfqTPPFyus/10/FlyEK7ZKIc66DrmA3IfdlYTpL7gICAOttQrMWNGODFu7JXaFyQahDarhFCPsvWMwyRK9yOLwihWj3lC1yPD/1xA7xpTGp9kX3ABKzzZxKjHoC5OYOhSLQm7MPnN4BND+Hs+cU/mYzLYxfN7GSDSbqZwhbJgXaKapT8lMeXUTlPejyqGyCPagWNqZJFHx6q1OBJKB8XZ0pZIpT+v+bMe5EnbQyv9Nj6BJX1BBgqhvKmXrSqD16",
      "metadata": {​​​​​​​​​​​​​​​​
          "notificationTypeID": "5",
          "notificationReason": "payment"
      }​​​​​​​​​​​​​​​​
  }​​​​​​​​​​​​​​​​
Decrypted Response to Successful Request
{​​​​​​​​​​​​​​​​
  "id": "6584251287300178228949",
  "reconcillationID": "85100194sale",
  "status": "settled",
  "submitTimeUTC": "2022-07-21T17:38:48Z",
  "clientReferenceInformation.code": "TC85100-1",
  "orderInformation.amountDetails.totalAmount": "1999.99",
  "orderInformation.amountDetails.currency": "GBP"
  
  }​​​​​​​​​​​​​​​​