Update webhook

post

https://sandbox-api.prioritycommerce.com/v1/passport/v1/customer/{parentIdType}/{customerId}/webhookSubscription/id/{id}

Update an existing webhook subscription. Modify the callback URL, subscribed events, or other configuration details.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

parentIdType

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:

customerId

string

required

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

int64

required

Passport-assigned identifier of the webhook subscription.

Body Params

Updated webhook subscription configuration.

Configuration for a webhook subscription.

name

string

Display name for the webhook subscription.

url

string

The callback URL where event notifications will be delivered.

description

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.

ownerType

string

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

acceptGzipEncoding

boolean

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

type

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.

Language

Credentials

Header

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200Webhook subscription updated successfully.