Choose the Documentation MX Merchant MX Connect
MX-Merchant-Documentation
🟢 MX Merchant MX Connect
Home Release Notes Documentation API Guide API Tryout
MX-Connect-Documentation
MX Merchant 🟢 MX Connect
Home Release Notes Documentation API Guide API Tryout
API Reference

Create webhook

post
https://api.sandbox.prioritypassport.com/v1/customer///webhookSubscription

Create a new webhook subscription for a customer. Specify the callback URL and the event types you want to subscribe to.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
string
enum
required

Identifier type for the customer. Use id for the Passport-assigned reference ID or externalId for the program manager-assigned identifier.

Allowed:
string
required

Unique identifier of the customer. The value corresponds to the identifier type specified in parentIdType.

Body Params

Webhook subscription configuration including callback URL and subscribed events.

Configuration for a webhook subscription.

string

Display name for the webhook subscription.

string

The callback URL where event notifications will be delivered.

string

A brief description of the webhook subscription's purpose.

subscribedEventType
array of strings

List of event type strings to subscribe to.

subscribedEventType
secret
object

Authentication token used to verify webhook payloads.

string

Specifies the owner scope of the webhook (e.g., CUSTOMER or PROGRAM_MANAGER).

boolean

Set to true if the callback endpoint accepts gzip-encoded payloads.

string

Type of webhook (e.g., BASIC, HMAC).

Responses

400

The request could not be accepted by the Passport server due to a malformed syntax, which may be a missing required parameter or other syntactical error.

401

The request lacks valid authentication credentials. Verify the API key and authorization header.

403

The authenticated user does not have permission to perform this operation.

500

An unexpected error occurred on the Passport server while processing the request.

Updated about 2 months ago

Language
Credentials
Header
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated about 2 months ago