Skip to content

Webhooks

Endpoints for webhooks. Every example sets SOOQUNA_TOKEN from the environment; see authentication. Responses are from a test store, cut to two items per list.

Endpoint Method Path
Subscribe to a webhook topic POST /webhooks
List webhook subscriptions GET /webhooks
Get a webhook subscription GET /webhooks/{id}
Update a webhook subscription PUT /webhooks/{id}
Send a test delivery POST /webhooks/{id}/test
List recent deliveries GET /webhooks/{id}/deliveries
Resend a delivery POST /webhooks/{id}/deliveries/{webhook_id}/resend
Pause a subscription POST /webhooks/{id}/disable
Resume a subscription POST /webhooks/{id}/enable
Delete a subscription DELETE /webhooks/{id}

POST /webhooks · Any token

Terminal window
curl -X POST "https://api.sooquna.com/admin/api/2026-10/webhooks" \
-H "X-Sooquna-Access-Token: $SOOQUNA_TOKEN" \
-H "Content-Type: application/json" \
-d '{
"topic": "orders/create",
"endpoint": "https://erp.example.com/sooquna/orders",
"api_version": "2026-10"
}'
Response 201
{
"api_version": "2026-10",
"app_id": "0193a1b2-c3d4-7e5f-8a6b-000000000047",
"app_name": "Docs",
"created_at": "2026-10-18T09:30:00Z",
"disabled_at": null,
"endpoint": "https://erp.example.com/sooquna/orders",
"failure_since": null,
"fields": [],
"id": "0193a1b2-c3d4-7e5f-8a6b-000000000048",
"metafield_namespaces": [],
"status": "active",
"topic": "orders/create",
"updated_at": "2026-10-18T09:30:00Z",
"version": 1
}

GET /webhooks · Any token

Terminal window
curl -X GET "https://api.sooquna.com/admin/api/2026-10/webhooks" \
-H "X-Sooquna-Access-Token: $SOOQUNA_TOKEN"
Response 200
{
"data": [
{
"api_version": "2026-10",
"app_id": "0193a1b2-c3d4-7e5f-8a6b-000000000047",
"app_name": "Docs",
"created_at": "2026-10-18T09:30:00Z",
"disabled_at": null,
"endpoint": "https://erp.example.com/sooquna/orders",
"failure_since": null,
"fields": [],
"id": "0193a1b2-c3d4-7e5f-8a6b-000000000048",
"metafield_namespaces": [],
"status": "active",
"topic": "orders/create",
"updated_at": "2026-10-18T09:30:00Z",
"version": 1
}
]
}

GET /webhooks/{id} · Any token

Parameter In Description
id path The resource’s ID.
Terminal window
curl -X GET "https://api.sooquna.com/admin/api/2026-10/webhooks/0193a1b2-c3d4-7e5f-8a6b-000000000048" \
-H "X-Sooquna-Access-Token: $SOOQUNA_TOKEN"
Response 200
{
"api_version": "2026-10",
"app_id": "0193a1b2-c3d4-7e5f-8a6b-000000000047",
"app_name": "Docs",
"created_at": "2026-10-18T09:30:00Z",
"disabled_at": null,
"endpoint": "https://erp.example.com/sooquna/orders",
"failure_since": null,
"fields": [],
"id": "0193a1b2-c3d4-7e5f-8a6b-000000000048",
"metafield_namespaces": [],
"status": "active",
"topic": "orders/create",
"updated_at": "2026-10-18T09:30:00Z",
"version": 1
}

PUT /webhooks/{id} · Any token

Parameter In Description
id path The resource’s ID.
Terminal window
curl -X PUT "https://api.sooquna.com/admin/api/2026-10/webhooks/0193a1b2-c3d4-7e5f-8a6b-000000000048" \
-H "X-Sooquna-Access-Token: $SOOQUNA_TOKEN" \
-H "Content-Type: application/json" \
-d '{
"topic": "orders/create",
"endpoint": "https://erp.example.com/sooquna/orders",
"fields": ["id", "name", "total_price", "financial_status"],
"version": 1
}'
Response 200
{
"api_version": "2026-10",
"app_id": "0193a1b2-c3d4-7e5f-8a6b-000000000047",
"app_name": "Docs",
"created_at": "2026-10-18T09:30:00Z",
"disabled_at": null,
"endpoint": "https://erp.example.com/sooquna/orders",
"failure_since": null,
"fields": ["id", "name"],
"id": "0193a1b2-c3d4-7e5f-8a6b-000000000048",
"metafield_namespaces": [],
"status": "active",
"topic": "orders/create",
"updated_at": "2026-10-18T09:30:00Z",
"version": 2
}

POST /webhooks/{id}/test · Any token

Parameter In Description
id path The resource’s ID.
Terminal window
curl -X POST "https://api.sooquna.com/admin/api/2026-10/webhooks/0193a1b2-c3d4-7e5f-8a6b-000000000048/test" \
-H "X-Sooquna-Access-Token: $SOOQUNA_TOKEN"

GET /webhooks/{id}/deliveries · Any token

Parameter In Description
id path The resource’s ID.
limit query For example 20.
Terminal window
curl -X GET "https://api.sooquna.com/admin/api/2026-10/webhooks/0193a1b2-c3d4-7e5f-8a6b-000000000048/deliveries?limit=20" \
-H "X-Sooquna-Access-Token: $SOOQUNA_TOKEN"
Response 200
{"data": []}

POST /webhooks/{id}/deliveries/{webhook_id}/resend · Any token

Parameter In Description
id path The resource’s ID.
webhook_id path The webhook ID.
Terminal window
curl -X POST "https://api.sooquna.com/admin/api/2026-10/webhooks/0193a1b2-c3d4-7e5f-8a6b-000000000048/deliveries/0193a1b2-0d08-78d5-8cf4-7748fc34dca0/resend" \
-H "X-Sooquna-Access-Token: $SOOQUNA_TOKEN"

POST /webhooks/{id}/disable · Any token

Parameter In Description
id path The resource’s ID.
Terminal window
curl -X POST "https://api.sooquna.com/admin/api/2026-10/webhooks/0193a1b2-c3d4-7e5f-8a6b-000000000048/disable" \
-H "X-Sooquna-Access-Token: $SOOQUNA_TOKEN"
Response 200
{
"api_version": "2026-10",
"app_id": "0193a1b2-c3d4-7e5f-8a6b-000000000047",
"app_name": "Docs",
"created_at": "2026-10-18T09:30:00Z",
"disabled_at": "2026-10-18T09:30:00Z",
"endpoint": "https://erp.example.com/sooquna/orders",
"failure_since": null,
"fields": ["id", "name"],
"id": "0193a1b2-c3d4-7e5f-8a6b-000000000048",
"metafield_namespaces": [],
"status": "disabled",
"topic": "orders/create",
"updated_at": "2026-10-18T09:30:00Z",
"version": 3
}

POST /webhooks/{id}/enable · Any token

Parameter In Description
id path The resource’s ID.
Terminal window
curl -X POST "https://api.sooquna.com/admin/api/2026-10/webhooks/0193a1b2-c3d4-7e5f-8a6b-000000000048/enable" \
-H "X-Sooquna-Access-Token: $SOOQUNA_TOKEN"
Response 200
{
"api_version": "2026-10",
"app_id": "0193a1b2-c3d4-7e5f-8a6b-000000000047",
"app_name": "Docs",
"created_at": "2026-10-18T09:30:00Z",
"disabled_at": null,
"endpoint": "https://erp.example.com/sooquna/orders",
"failure_since": null,
"fields": ["id", "name"],
"id": "0193a1b2-c3d4-7e5f-8a6b-000000000048",
"metafield_namespaces": [],
"status": "active",
"topic": "orders/create",
"updated_at": "2026-10-18T09:30:00Z",
"version": 4
}

DELETE /webhooks/{id} · Any token

Parameter In Description
id path The resource’s ID.
Terminal window
curl -X DELETE "https://api.sooquna.com/admin/api/2026-10/webhooks/0193a1b2-c3d4-7e5f-8a6b-000000000048" \
-H "X-Sooquna-Access-Token: $SOOQUNA_TOKEN"
Response 204
{}

Was this page helpful?