Get Available Webhook Events

Retrieves a list of all available webhook event types that you can subscribe to.

Endpoint

GET /v1/webhook-subscriptions/available-events

Authentication

API key required. Include it in the Authorization header:

Authorization: Bearer YOUR_API_KEY

Response

200 OK

{
  "data": [
    {
      "value": "shipping_channel.created",
      "label": "Shipping Channel Created",
      "description": "Fires when a new shipping channel is created"
    },
    {
      "value": "shipping_channel.updated",
      "label": "Shipping Channel Updated",
      "description": "Fires when a shipping channel is updated"
    },
    {
      "value": "shipping_channel.deleted",
      "label": "Shipping Channel Deleted",
      "description": "Fires when a shipping channel is deleted"
    },
    {
      "value": "shipping_channel.validated",
      "label": "Shipping Channel Validated",
      "description": "Fires when a shipping channel is successfully validated"
    },
    {
      "value": "shipping_channel.status_changed",
      "label": "Shipping Channel Status Changed",
      "description": "Fires when a shipping channel's status changes"
    },
    {
      "value": "tracking_parcel.created",
      "label": "Tracking Parcel Created",
      "description": "Fires when a new tracking parcel is created"
    },
    {
      "value": "tracking_parcel.updated",
      "label": "Tracking Parcel Updated",
      "description": "Fires when a tracking parcel is updated"
    },
    {
      "value": "tracking_parcel.deleted",
      "label": "Tracking Parcel Deleted",
      "description": "Fires when a tracking parcel is deleted"
    },
    {
      "value": "tracking_parcel.status_changed",
      "label": "Tracking Parcel Status Changed",
      "description": "Fires when a tracking parcel's status changes"
    }
  ]
}

Error Responses

Status Code	Description
401	Unauthorized - Invalid or missing API key
429	Too Many Requests - Rate limit exceeded
500	Server Error - Something went wrong on our end

Example Request

cURL

curl -X GET \
  https://api.shipping-channels.com/v1/webhook-subscriptions/available-events \
  -H "Authorization: Bearer YOUR_API_KEY"

PHP

<?php
$client = new \GuzzleHttp\Client();

$response = $client->request('GET', 'https://api.shipping-channels.com/v1/webhook-subscriptions/available-events', [
    'headers' => [
        'Authorization' => 'Bearer YOUR_API_KEY',
        'Accept' => 'application/json',
    ],
]);

$data = json_decode($response->getBody(), true);

JavaScript

fetch('https://api.shipping-channels.com/v1/webhook-subscriptions/available-events', {
  method: 'GET',
  headers: {
    'Authorization': 'Bearer YOUR_API_KEY',
    'Accept': 'application/json'
  }
})
.then(response => response.json())
.then(data => console.log(data))
.catch(error => console.error('Error:', error));