Logo
Logo
⌘K

The Webhook Object

Attributes

filters

object

Filters for the webhook.
Possible values
OrderStatusChange
Filters when topic is OrderStatusChange.
Show object attributes

statuses

array of enums

Order status changes to subscribe to.
Possible enum values
PendingFulfillmentAction
The order requires user action before it can be sent to production.
AwaitingPayment
The order has been received by Artelo but is not yet paid for in the connected integration.
Received
The order is received and is waiting to be sent to production. This period is to allow for cancellations to take place before production begins.
InProduction
The production facility is currently processing the order.
Shipped
The order has been shipped.
Delivered
The order has been delivered.
Canceled
The order was canceled.
Show more values
ProductSetUpdated
Filters when topic is ProductSetUpdated.
Show object attributes

productSetIds

array of strings

Unique identifiers of product sets to subscribe to changes for. If not included, the webhook will subscribe to changes for all product sets.
UploadStatusChange
Filters when topic is UploadStatusChange.
Show object attributes

statuses

array of enums

Upload status changes to subscribe to.
Possible enum values
Success
The image was successfully uploaded.
Fail
The image failed to upload.
Deleted
The image has been deleted.

id

string

Unique identifier of the webhook.

numFailures

number

Number of consecutive failures the webhook has had since its last successful response.

secret

string

Secret used to sign the webhook payload.

topic

enum

Topic the webhook is subscribed to.
Possible enum values
OrderStatusChange
Triggered when the status of an order changes.
UploadStatusChange
Triggered when an upload fails or succeeds to upload.
ProductSetUpdated
Triggerred when a product set is updated.

url

string

URL where POST requests are sent for the webhook.
Webhook Object
{
  "filters": {
    "statuses": [
      "Shipped"
    ]
  },
  "id": "e747b74f-ae93-4594-a434-7fa3d7789ce8",
  "numFailures": 0,
  "secret": "test-secret",
  "topic": "OrderStatusChange",
  "url": "https://api.example.com/artelo-webhook"
}