POST /v3/webhooks/subscriptions
This request creates a subscription for notifications to an event.
Create a subscription by selecting the event type, event version, and resource name, and also providing the event URL. Users can subscribe to one or multiple notifications in a single subscription request.
Use the Retrieve event types request (GET /webhooks/eventTypes
) to get a list of event types, event versions, and resources name available for subscription. Configure an event URL to receive the notifications.
URL Authentication Options
AUTH Method as BASIC_AUTH
While making a notification request to endpoint URL, the Walmart system will pass the authentication header with a key as authHeaderName
and a value as BASE64 encoding for the username and password.
AUTH Method as HMAC
While making a notification request to the endpoint URL, the Walmart system will pass the authentication header with a key as authHeaderName
and a value as HMACSHA256 for a complete response, using the clientSecret
as the key.
AUTH Method as OAUTH
The Walmart system will make a POST call to the OAUTH URL to generate a token with the request body as grant_type=client_credentials
and headers as follows:
- Authorization header with the key as
authHeaderName
and value as BASE64 encoding forclientId
andclientSecret
- Accept header as
application/json
- Content-type header as
application/x-www-form-urlencoded
See the Create an access token request (POST /v3/token
) for more information.
Custom Headers
If custom headers are provided in the headers
field and if the provided OAUTH URL return HTTPS status 200, the response has the access_token
and expires_in
fields.
While making a notification request to the endpoint URL, the Walmart system will pass the access_token
value in the headers with authHeaderName
as key and value as Bearer
, along with any other custom headers provided in the headers
field.