List the calling vendor's webhook subscriptions

GET

/api/v1/vendor/webhooks

const url = 'https://api-omni.linra.net/api/v1/vendor/webhooks?page=1&pageSize=20';
const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request GET \
  --url 'https://api-omni.linra.net/api/v1/vendor/webhooks?page=1&pageSize=20' \
  --header 'Authorization: Bearer <token>'

Lists every webhook subscription owned by the calling vendor. Never returns a secret. No activeOnly filter — the subscription cap is small and you benefit from seeing inactive ones too. Requires the Orders capability.

Authorizations

vendorBearer

Parameters

Query Parameters

page

integer

default: 1 >= 1

pageSize

integer

default: 20 >= 1 <= 100

Responses

200

A page of webhook subscriptions.

application/json

object

state

required

string

payload

required

details

object

payload

required

object

items

Array<object>

object

string format: uuid

vendorId

string format: uuid

url

string format: uri

eventTypes

Array<string>

Allowed values: vendor.order.assigned vendor.offer.review-decision

isActive

boolean

lastDeliveryAt

string format: date-time

nullable

lastDeliveryStatus

string

nullable

createdAt

string format: date-time

nullable

pagination

object

page

integer

pageSize

integer

totalCount

integer

totalPages

integer

Example

{
  "state": "SUCCESS",
  "payload": {
    "items": [
      {
        "eventTypes": [
          "vendor.order.assigned"
        ]
      }
    ]
  }
}

403

Your token doesn’t carry the capability this endpoint requires.

application/json

object

state

required

string

payload

details

object

Examples

missingCapability

{
  "state": "FORBIDDEN_CAPABILITY_NOT_GRANTED",
  "payload": null,
  "details": {
    "requiredCapability": "Orders"
  }
}

429

Too many requests. Retry after the Retry-After header (seconds).

application/json

object

state

required

string

payload

details

object

Example

{
  "state": "NOT_FOUND_VENDOR_OFFER"
}

Headers

Retry-After

integer

Seconds to wait before retrying.