Enable Webhook

curl -X POST \
  'https://platform.returnqueen.dev/api/partner_webhooks/ep_2KtRQ8fTStWPKrXP/enable' \
  -H 'X-API-KEY: your-api-key'

{
  "id": "ep_2KtRQ8fTStWPKrXP",
  "url": "https://example.com/webhook",
  "filterTypes": ["shipment.created", "shipment.address.updated", "pickup.completed"],
  "active": true,
  "created_at": "2024-01-15T10:00:00Z",
  "description": "Production webhook endpoint"
}

POST

api

partner_webhooks

{partner_webhooks_id}

enable

curl -X POST \
  'https://platform.returnqueen.dev/api/partner_webhooks/ep_2KtRQ8fTStWPKrXP/enable' \
  -H 'X-API-KEY: your-api-key'

{
  "id": "ep_2KtRQ8fTStWPKrXP",
  "url": "https://example.com/webhook",
  "filterTypes": ["shipment.created", "shipment.address.updated", "pickup.completed"],
  "active": true,
  "created_at": "2024-01-15T10:00:00Z",
  "description": "Production webhook endpoint"
}

Request Parameters

Path Parameters

string

required

Webhook endpoint ID

curl -X POST \
  'https://platform.returnqueen.dev/api/partner_webhooks/ep_2KtRQ8fTStWPKrXP/enable' \
  -H 'X-API-KEY: your-api-key'

{
  "id": "ep_2KtRQ8fTStWPKrXP",
  "url": "https://example.com/webhook",
  "filterTypes": ["shipment.created", "shipment.address.updated", "pickup.completed"],
  "active": true,
  "created_at": "2024-01-15T10:00:00Z",
  "description": "Production webhook endpoint"
}

Once enabled, the webhook will start receiving events again based on its configured filter types.

Response Fields

string

Unique identifier for the webhook endpoint

string

HTTPS URL where webhook events are sent

array

Event types this endpoint is subscribed to

boolean

Whether the endpoint is active (will be true after enabling)

string

When the endpoint was created (ISO 8601 format)

string

Description of the webhook endpoint

Shipments

Availability

Webhooks

Request Parameters

Path Parameters

Response Fields

​Request Parameters

​Path Parameters

​Response Fields

Request Parameters

Path Parameters

Response Fields