webhook

webhook.create

Create webhook on the store and subscribe to it.

post/webhook.create.json

Request

  • Base URL: https://api.api2cart.com/v1.1
  • URL: https://api.api2cart.com/v1.1/webhook.create.json
  • Auth: API key in header x-api-key and API key in header x-store-key

Request body

entitystring required

Specify the entity that you want to enable webhooks for (e.g product, order, customer, category)

actionstring required

Specify what action (event) will trigger the webhook (e.g add, delete, or update)

callbackstring required

Callback where the webhook should send the POST request when the event occurs

labelstring

The name you give to the webhook

fieldsstring

Fields the webhook should send

response_fieldsstring

Set this parameter to choose which entity fields to retrieve. Use comma-separated field names in curly braces, nested to match the response structure, e.g. {result{product{id,name}}}. The wildcard * returns every field at a level: {} gives the whole response, {result{product{}}} all product fields.

activeboolean

Webhook status

lang_idstring

Language id

store_idstring

Defines store id where the webhook should be assigned

idempotency_keystring

A unique identifier associated with a specific request. Repeated requests with the same <strong>idempotency_key</strong> return a cached response without re-executing the business logic. <strong>Please note that the cache lifetime is 15 minutes.</strong>

Example request

{
  "entity": "product",
  "action": "add",
  "callback": "https://example.com/callback",
  "label": "Super webhook",
  "fields": "id, name, description",
  "response_fields": "{result}",
  "active": true,
  "store_id": "1",
  "idempotency_key": "098f6bcd4621d373cade4e832627b4f6"
}

Response

successful operation

return_codeinteger
return_messagestring

Changes

No recorded changes to this operation across all 1 revision of this API.