API Overview

Webhooks Implementation Guide
- Recent Revisions to This Document

Introduction to Webhooks
- Webhooks Integration Overview
- Supported Products and Event Types

Set Up Your Security

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

Create a Digital Signature Key

(Optional) Provide Your OAuth Credentials

Retrieve a List of Products and Events

Message-Level Encryption
- Preparing Your Workspace
- Generate Certificate and Key Pair
- Register the Certificate
  - Required Fields for Registering Your Message-Level Encryption Keys
  - Example: Registering Your Certificate
- Security Best Practices
- Troubleshooting
- Viewing Certificate Details

Create a Webhook Subscription
- Create a Webhook Subscription
- Create a Webhook Subscription Using OAuth
- Create a Webhook Subscription Using OAuth with JWT
- Create a Sample Webhook Subscription

Optional Set-Up Tasks
- Webhook Health Check URL and Automatic Revalidation
- Configure the Retry Policy

Webhook Notification Field Descriptions

Example: Notification Payload

Manage Webhook Subscriptions Requests
- Retrieve the Details of a Webhook Subscription
- Retrieve All of an Organization's Subscriptions
- Update a Webhook Subscription
- Delete a Webhook Subscription
- Verify a Webhook Subscription's Configuration
- Activate a Webhook Subscription
- Deactivate a Webhook Subscription

Troubleshooting Webhook Subscriptions

On This Page

Register the Certificate

Use the REST API to register and store your certificate. Each webhook subscription requires its own unique asymmetric certificate.

Endpoints

Send a POST request to one of these endpoints:

Test:

POST https://api.smartpayfuse-test.barclaycard/kms/egress/v2/keys-asym

Production:

POST https://api.smartpayfuse.barclaycard/kms/egress/v2/keys-asym

Back to top