Documentation | Artelo

Get Webhooks

Fetch webhooks created by the API integration.

Parameters

isFailing

boolean

Filter to only return webhooks based on whether or not they are currently failing. After 20 failures, webhooks will be automatically removed.

limit

number

Number of results to return in each paginated query.

offset

number

Offset for pagination.

topics

array of enums

Webhook topics to filter by.

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.

Returns

A list of Webhook objects.

Test with your own API key

GET

/webhooks/get

curl -G 'https://www.artelo.io/api/open/webhooks/get' \
  -H 'Authorization: Bearer your-token'

curl -G 'https://www.artelo.io/api/open/webhooks/get' \
  -H 'Authorization: Bearer your-token'

Response

[
  {
    "filters": {
      "statuses": [
        "Canceled",
        "Shipped"
      ]
    },
    "id": "e747b74f-ae93-4594-a434-7fa3d7789ce8",
    "numFailures": 0,
    "secret": "test-secret",
    "topic": "OrderStatusChange",
    "url": "https://api.example.com/artelo-webhook"
  }
]

[
  {
    "filters": {
      "statuses": [
        "Canceled",
        "Shipped"
      ]
    },
    "id": "e747b74f-ae93-4594-a434-7fa3d7789ce8",
    "numFailures": 0,
    "secret": "test-secret",
    "topic": "OrderStatusChange",
    "url": "https://api.example.com/artelo-webhook"
  }
]