POST
/
subscription_oncreate_v2
/
Subscribe to a webhook event
curl --request POST \
  --url https://api.ekhodealer.com/subscription_oncreate_v2/ \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "oemKey": "<string>",
  "brandKey": "<string>",
  "targetUrl": "<string>",
  "actionName": "placedOrder"
}'
{
  "success": "<string>"
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json
​
oemKey
string

Key to identify and authenticate the OEM admin.

​
brandKey
string

The brand key of the OEM.

​
targetUrl
string

The URL to which the webhook event will be sent.

​
actionName
enum<string>

The name of the action to subscribe to. Whenever a subscribed to action is performed, a webhook event will be sent to the target URL.

Available options:
placedOrder,
purchasedVehicle,
purchasedAccessory,
vehiclePaymentStatus,
vehicleFulfillmentStatus,
vehicleStage,
surveyComplete,
preorder

Response

Successfully subscribed a URL to a specified webhook event.

​
success
string

Success message