Limited Availability Release

Recent Revisions to This Document

About This Guide

VISA Platform Connect: Specifications and Conditions for Resellers/Partners

Introducing Webhooks
- Webhooks Benefits
- Webhooks Requirements
- Webhooks Workflow Options

Set Up Webhooks
- Mutual Trust Subscriptions
  - Set Up Server Security
  - Creating a Shared Secret Key Pair
  - Request a Digital Signature Key
    - Required Fields for Digital Signature Key
    - Example: Requesting a Digital Signature Key
  - Products and Events
    - Request a List of Products and Events
    - Example: Requesting a List Products and Event
  - Subscribe to Webhooks Using Mutual Trust
    - Required Fields for Subscribing to Webhooks Using Mutual Trust
    - Optional Fields for Subscribing to Webhooks Using Mutual Trust
    - Example: Creating a Webhook Subscription Using Mutual Trust
    - Notification Scope
    - Health Check URL
    - Subscription Status
    - Product and Event Types
  - Notification Format
    - Example: Notification Payload
- OAuth Subscriptions
  - Set Up Server Security
  - Creating a Shared Secret Key Pair
  - Request a Digital Signature Key
    - Required Fields for Digital Signature Key
    - Example: Requesting a Digital Signature Key
  - Send OAuth Credentials
    - Required Fields for Sending Your OAuth Credentials
    - Example: Sending Your OAuth Credentials
  - Products and Events
    - Request a List of Products and Events
    - Example: Requesting a List Products and Event
  - Subscribe to Webhooks Using OAuth
    - Required Fields for Subscribing to Webhooks Using OAuth
    - Optional Fields for Subscribing to Webhooks Using OAuth
    - Example: Creating a Webhook Subscription Using OAuth
    - Notification Scope
    - Health Check URL
    - Subscription Status
    - Product and Event Types
  - Notification Format
    - Example: Notification Payload
- OAuth with JWT Subscriptions
  - Set Up Server Security
  - Creating a PKCS12 File
  - Request a Digital Signature Key
    - Required Fields for Digital Signature Key
    - Example: Requesting a Digital Signature Key
  - Send OAuth Credentials
    - Required Fields for Sending Your OAuth Credentials
    - Example: Sending Your OAuth Credentials
  - Products and Events
    - Request a List of Products and Events
    - Example: Requesting a List Products and Event
  - Subscribe to Webhooks Using OAuth with JWT
    - Required Fields for Subscribing to Webhooks Using OAuth with JWT
    - Optional Fields for Subscribing to Webhooks Using OAuth with JWT
    - Example: Creating a Webhook Subscription Using OAuth with JWT
    - Notification Scope
    - Health Check URL
    - Subscription Status
    - Product and Event Types
  - Notification Format
    - Example: Notification Payload

Managing Subscriptions
- Retrieving the Details of a Webhook Subscription
  - Example: Retrieving the Details of a Webhook Subscription
- Retrieving an Organization's Subscriptions Using the Product and Event
  - Required Query Parameters for Retrieving an Organization's Subscriptions Using the Product and Event
  - Example: Retrieving an Organization's Subscriptions Using the Product and Event
- Updating a Webhook Subscription
  - Example: Updating a Webhook Subscription
- Deleting a Webhook Subscription
  - Example: Deleting a Webhook Subscription

Troubleshooting Webhook Subscriptions

REST API Keys
- Creating a REST API Key

Optional Tasks
- Notification Validation
  - Digital Signature Format
  - Validating a Notification
  - Example: Validating a Notification
- Retry Policy
  - Example: Retry Policy in a Subscription Request
- Notification Replay
  - Replaying Notifications Using Transaction Trace Identifiers
    - Required Field for Replaying Notifications Using Transaction Trace Identifiers
    - Example: Replaying Notifications Using Transaction Trace Identifiers
  - Replaying Notifications Using Start Time and End Time
    - Required Fields for Replaying Notifications Using Start and End time
    - Example: Replaying Notifications Using Start and End Time
  - Replaying Notifications Using Hours Back
    - Required Fields for Replaying Notifications using Hours Back
    - Example: Replaying Notifications Using Hours Back
- Testing API Requests
  - Triggering a Test Webhook Notification Using the Token Management Service

On This Page

REST API

Example: Creating a Webhook Subscription Using OAuth

Request

{
  "name": "Terminal Management Webhook",
  "description": "Notification of assignment updates",
  "organizationId": "org1",
  "productId": "terminalManagement",
  "eventTypes": [
    "terminalManagement.assignment.update"
  ],
  "webhookUrl": "https://mywebhookserver.com:8443/simulateclient",
  "healthCheckUrl": "https://mywebhookserver.com:8443/simulateclienthealthcheck",
  "notificationScope": "SELF",
  "securityPolicy": {
    "securityType": "oAuth",
    "config": {
      "oAuthTokenExpiry": "365",
      "oAuthURL": "https://mywebhookserver.com/oauthtoken",
      "oAuthTokenType": "Bearer"
    }
  }
}

Response

{
  "organizationId" : "org1",
  "productId" : "terminalManagement",
  "eventTypes" : [ 
	"terminalManagement.assignment.update" 
],
  "webhookId" : "d7399cb6-ff9f-72d9-e053-3cb8d30a62ee",
  "webhookUrl" : "https://mywebhookserver.com/simulateclient",
  "healthCheckUrl" : "https://mywebhookserver.com/simulateclient/healthcheck",
  "createdOn" : "2022-02-04T22:17:43.045Z",
  "status" : "INACTIVE",
  "retryPolicy" : {
    "algorithm" : "ARITHMETIC",
    "firstRetry" : "1",
    "interval" : "1",
    "numberOfRetries" : "3",
    "deactivateFlag" : "false",
    "repeatSequenceCount" : "0",
    "repeatSequenceWaitTime" : "0"
  },
  "securityPolicy" : {
    "securityType" : "oAuth",
    "proxyType" : "internal",
    "digitalSignatureEnabled" : "yes",
    "config" : {
      "oAuthTokenExpiry" : "300,
      "oAuthURL" : "https://myoauthserver.com/simulator/v1/token",
      "oAuthTokenType" : "Bearer"
    }
  },
  "version" : "3",
  "notificationScope" : "SELF"
}