curl -X GET \
'https://platform.returnqueen.dev/api/webhooks/event-types' \
-H 'X-API-KEY: your-api-key'
{
"event_types": [
{
"name": "shipment.created",
"description": "Triggered when a new shipment is created",
"category": "shipment",
"schema": {
"shipment_id": "string",
"order_number": "string",
"status": "string",
"created_at": "datetime"
}
},
{
"name": "shipment.cancelled",
"description": "Triggered when a shipment is cancelled",
"category": "shipment",
"schema": {
"shipment_id": "string",
"order_number": "string",
"cancelled_at": "datetime",
"cancelled_reason": "string"
}
},
{
"name": "pickup.completed",
"description": "Triggered when a pickup is completed",
"category": "pickup",
"schema": {
"pickup_id": "string",
"completed_at": "datetime",
"shipment_ids": "array"
}
}
]
}
Returns all available webhook event types that partners can subscribe to
curl -X GET \
'https://platform.returnqueen.dev/api/webhooks/event-types' \
-H 'X-API-KEY: your-api-key'
{
"event_types": [
{
"name": "shipment.created",
"description": "Triggered when a new shipment is created",
"category": "shipment",
"schema": {
"shipment_id": "string",
"order_number": "string",
"status": "string",
"created_at": "datetime"
}
},
{
"name": "shipment.cancelled",
"description": "Triggered when a shipment is cancelled",
"category": "shipment",
"schema": {
"shipment_id": "string",
"order_number": "string",
"cancelled_at": "datetime",
"cancelled_reason": "string"
}
},
{
"name": "pickup.completed",
"description": "Triggered when a pickup is completed",
"category": "pickup",
"schema": {
"pickup_id": "string",
"completed_at": "datetime",
"shipment_ids": "array"
}
}
]
}
curl -X GET \
'https://platform.returnqueen.dev/api/webhooks/event-types' \
-H 'X-API-KEY: your-api-key'
{
"event_types": [
{
"name": "shipment.created",
"description": "Triggered when a new shipment is created",
"category": "shipment",
"schema": {
"shipment_id": "string",
"order_number": "string",
"status": "string",
"created_at": "datetime"
}
},
{
"name": "shipment.cancelled",
"description": "Triggered when a shipment is cancelled",
"category": "shipment",
"schema": {
"shipment_id": "string",
"order_number": "string",
"cancelled_at": "datetime",
"cancelled_reason": "string"
}
},
{
"name": "pickup.completed",
"description": "Triggered when a pickup is completed",
"category": "pickup",
"schema": {
"pickup_id": "string",
"completed_at": "datetime",
"shipment_ids": "array"
}
}
]
}