[go: nahoru, domu]
Skip to content

Latest commit

 

History

History
45 lines (25 loc) · 4.24 KB

GeinsWebhookItem.md

File metadata and controls

45 lines (25 loc) · 4.24 KB
Raw

GeinsSdkApiMgmtJavascript.GeinsWebhookItem

Properties

Name Type Description Notes
id String Webhook Id [optional]
entity Number Type of entity. 0 = NOT_SET 1 = Brand 2 = Capture 3 = Category 4 = Customer 5 = Order 6 = PageWidget 7 = Product 8 = Refund 9 = Supplier [optional]
name String Webhook Name [optional]
description String Webhook Description [optional]
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` [optional]
method String Http Method to use [optional]
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. [optional]
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. [optional]
headers String Headers to send with the webhook [optional]
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`. [optional]

Enum: EntityEnum

  • 0 (value: 0)

  • 1 (value: 1)

  • 2 (value: 2)

  • 3 (value: 3)

  • 4 (value: 4)

  • 5 (value: 5)

  • 6 (value: 6)

  • 7 (value: 7)

  • 8 (value: 8)

  • 9 (value: 9)