Create webhook

Creates a new webhook with the provided information.

Request Body — REQUIRED The information required to create a new webhook.
Entity int32 Possible values: [0, 1, 2, 3, 4, 5, 6, 7, 8, 9] Type of entity. 0 = NOT_SET 1 = Brand 2 = Capture 3 = Category 4 = Customer 5 = Order 6 = PageWidget 7 = Product 8 = Refund 9 = Supplier
Name string Webhook Name
Description string Webhook Description
Actions string Comma separated list of actions to listen for. Possible actions per entity are: Product, Brand, Category, Supplier - create, update, delete Order - create, update, cancel, activate, lock, complete Capture, Refund - create PageWidget - update, delete Customer - delete, passwordreset, obfuscate
Method string Http Method to use
Url string Url to send the webhook to. Placeholders can be used to customize the URL. Always available placeholders: {{entity}} - Product, Brand, Category, etc {{action}} - create, update, delete, etc {{account}} - usually the name of your webshop {{environment}} - prod, dev, qa, etc {{id}} -(can be a comma separated list of ids. Partially available placeholders: {{paymentName}} - name of payment method. Only applicable for capture and refund {{channelName}} - name of the channel (web site). Only applicable for capture and refund {{channelUrl}} - url of the channel (web site). Only applicable for password reset {{resetKey}} - key for password reset. Only applicable for password reset Note: Not all placeholders are available for all combinations of entities and actions. Ensure that the placeholders you use are relevant to the webhook's entity and action.
Body string Body of the webhook. Placeholders can be used to customize the body. Always available placeholders: {{entity}} - Product, Brand, Category, etc {{action}} - create, update, delete, etc {{account}} - usually the name of your webshop {{environment}} - prod, dev, qa, etc {{id}} -(can be a comma separated list of ids. Partially available placeholders: {{paymentName}} - name of payment method. Only applicable for capture and refund {{channelName}} - name of the channel (web site). Only applicable for capture and refund {{channelUrl}} - url of the channel (web site). Only applicable for password reset {{resetKey}} - key for password reset. Only applicable for password reset Note: Not all placeholders are available for all combinations of entities and actions. Ensure that the placeholders you use are relevant to the webhook's entity and action.
Headers string Headers to send with the webhook
Retry boolean True if the webhook should be retried on failure. Retries are attempted up to 3 times with an interval of 10 minutes. Each retry attempt will include a unique HTTP header called x-Idempotency-Key and a timestamp for when the webhook event was initiated. This key serves as an identifier for each specific webhook event and remains the same for all retry attempts of the same webhook event. The primary purpose of the x-Idempotency-Key is to enable the receiving system to identify and handle duplicate webhook events, thus preventing duplicate processing of the same webhook event. The timestamp header is called x-timestamp.

Responses
200 The unique identifier of the newly created webhook. Schema — OPTIONAL Resource uuid — OPTIONAL The resource on which the action was taken. Message string — OPTIONAL A status message for the action taken. Details string[] — OPTIONAL Any validation messages for the data on the current action.
400 Bad request. Schema — OPTIONAL Resource uuid — OPTIONAL The resource on which the action was taken. Message string — OPTIONAL A status message for the action taken. Details string[] — OPTIONAL Any validation messages for the data on the current action.
500 Internal server error. Schema — OPTIONAL Resource uuid — OPTIONAL The resource on which the action was taken. Message string — OPTIONAL A status message for the action taken. Details string[] — OPTIONAL Any validation messages for the data on the current action.