API Overview

Webhooks Implementation Guide
- Limited Availability Release
- Recent Revisions to This Document
- VISA Platform Connect: Specifications and Conditions for Resellers/Partners

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

Set Up Webhooks
- Subscribing to Webhooks Using Mutual Trust
  - Setting Up Server Security
  - Create a Shared Secret Key Pair
  - Requesting a Digital Signature Key
    - Required Fields for Requesting a Digital Signature Key
    - Example: Requesting a Digital Signature Key
  - Products and Events
    - Requesting a List of Products and Events
    - Example: Requesting a List Products and Event
  - Subscribing 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
- Subscribing to Webhooks Using OAuth
  - Setting Up Server Security
  - Create a Shared Secret Key Pair
  - Requesting a Digital Signature Key
    - Required Fields for Requesting a Digital Signature Key
    - Example: Requesting a Digital Signature Key
  - Sending OAuth Credentials
    - Required Fields for Sending Your OAuth Credentials
    - Example: Sending Your OAuth Credentials
  - Products and Events
    - Requesting a List of Products and Events
    - Example: Requesting a List Products and Event
  - Subscribing 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
- Subscribing to Webhooks Using OAuth with JWT
  - Setting Up Server Security
  - Create a P12 File
  - Requesting a Digital Signature Key
    - Required Fields for Requesting a Digital Signature Key
    - Example: Requesting a Digital Signature Key
  - Sending OAuth Credentials
    - Required Fields for Sending Your OAuth Credentials
    - Example: Sending Your OAuth Credentials
  - Products and Events
    - Requesting 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

Create REST API Keys
- Create a P12 File
- Create a Shared Secret Key Pair

Product and Event Types

Optional Tasks
- Notification Validation
  - Digital Signature Format
  - Validating a Notification
  - Example: Validating a Notification
- Retry Policy
  - Example: Retry Policy in a Subscription Request
- Testing API Requests
  - Triggering a Test Webhook Notification Using the Token Management Service

Set Up Webhooks

You can subscribe to notifications for a variety of events. After creating a subscription, you can get details about it, update it, and delete it, all from the same endpoint.

You can subscribe to webhooks using the following types of security policies:

Mutual Trust

OAuth

OAuth with JWT

For information about products and event types, see Product and Event Types.

Subscribing to Webhooks Using Mutual Trust

This section describes the tasks that must be accomplished in order to subscribe to webhooks using Mutual Trust.

Webhooks Subscription Workflow Using Mutual Trust

Follow these steps to set up your webhooks subscription using Mutual Trust:

Set up your server security to receive webhooks notifications.

Generate API security keys for authenticating API requests. You must generate separate keys for the testing and production environments.

Request a digital signature key.

Request a product list.

Subscribe to webhooks event notifications.

Subscribing to Webhooks Using OAuth

This section describes the tasks that you must accomplish in order to subscribe to webhooks using OAuth.

Webhooks Subscription Workflow Using OAuth

Follow these steps to set up your webhooks subscription using OAuth:

Set up your server security to receive webhooks notifications.

Generate API security keys for authenticating API requests. You must generate separate keys for the testing and production environments.

Request a digital signature key.

Send your OAuth credentials.

Request a product list.

Subscribe to webhooks event notifications.

Subscribing to Webhooks Using OAuth with JWT

This section describes the tasks that must be accomplished in order to subscribe to webhooks using OAuth with JSON Web Token (JWT).

Webhooks Subscription Workflow Using OAuth with JWT

Follow these steps to set up your webhooks subscription using OAuth with JWT:

Set up your server security to receive webhooks notifications. Include app-specific certifications.

Generate API security keys for authenticating API requests. You must generate separate keys for the testing and production environments.

Request a digital signature key.

Send your OAuth credentials.

Request a product list.

Subscribe to webhooks event notifications.