On This Page
Webhooks Integration Overview
Follow these steps to set up your system to support the Webooks REST API. Some of these steps
are dependent on your system's security policy.
Figure:
Set Up Webhook Subscriptions Workflow
- Set up a server with a URL to receive webhook notifications.
- Configure your server security to receive webhooks notifications. For more information, see Set Up Your Security.
- Create a REST API security key that is compliant with your security policy. Security keys are used to authenticate the requests you send toCybersource. You must create separate keys for the testing and production environments. For more information, see Create REST API Keys.
- Request a digital signature key fromCybersource. For more information, see Create a Digital Signature Key.
- If your webhooks integration will include subscriptions to payment event notifications, implement message-level encryption for those events. See Message-Level Encryption.
- If your system uses theOAuthorOAuth with JWTsecurity policy, you must provide your OAuth credentials toCybersource. OAuth is not required and Mutual Trust is the default. If you are not using OAuth, skip this step. For more information, see (Optional) Provide Your OAuth Credentials.
- Request a list of the products for which your organization is enabled to receive webhook notifications. For more information, see Retrieve a List of Products and Events.IMPORTANTIf your webhooks integration will include subscriptions to payment event notifications, implement message-level encryption for those events. See Message-Level Encryption.
- Create your webhook subscription event notifications. For more information, see Create a Webhook Subscription.
Optional Set Up Tasks
You can complete these optional tasks after creating a webhook subscription.
- Include a health check URL to enableCybersourceto monitor your server's status for reliability. For more information, see Webhook Health Check URL and Automatic Revalidation.
- Customize the retry policy for unresponsive webhook and health check URLs. For more information, see Configure the Retry Policy.
- Validate your digital signature. For more information, see Validating a Notification with the Digital Signature Key.