مرجع الواجهة
إشعارات Webhook
Your own signed webhook subscriptions: events pushed to your address instead of polling.
GETYour subscriptions#
/partner/v1/webhooksScope webhooks:manage. Your own subscriptions on the Let’s Pizza webhook service: signed deliveries (X-LP-Signature: v1=<hex HMAC-SHA256(secret, "<X-LP-Timestamp>.<raw body>")>), retries after 1 min, 5 min, 30 min, 2 h and 12 h, a delivery log and replay. The branches are your key’s; whether the customer’s full details travel is your settings.customerData, not the request.
curl -sS "$LP_BASE_URL/partner/v1/webhooks" \
-H "Authorization: Bearer $LP_API_KEY"الردود
200OKWebhookSubscription[]
الترويسات
| الاسم | النوع | الوصف |
|---|---|---|
X-Request-Id | string | The id of this request: quote it to support. Send your own (8–64 of A-Z a-z 0-9 . _ -) to trace a call end to end. |
RateLimit-Limit | integer | The key's requests per minute. |
RateLimit-Remaining | integer | Requests left in the current minute. |
RateLimit-Reset | integer | Seconds until the minute window resets. |
البنية
401UNAUTHENTICATED (no key, a wrong or revoked one), KEY_EXPIRED, KEY_ENVIRONMENT_MISMATCH (a test key on production or the other way round)PartnerError
الترويسات
| الاسم | النوع | الوصف |
|---|---|---|
X-Request-Id | string | The id of this request: quote it to support. Send your own (8–64 of A-Z a-z 0-9 . _ -) to trace a call end to end. |
403PARTNER_SUSPENDED, IP_NOT_ALLOWED, SCOPE_REQUIRED (detail.required lists the scopes), BRANCH_NOT_ALLOWEDPartnerError
الترويسات
| الاسم | النوع | الوصف |
|---|---|---|
X-Request-Id | string | The id of this request: quote it to support. Send your own (8–64 of A-Z a-z 0-9 . _ -) to trace a call end to end. |
429RATE_LIMITED: wait Retry-After seconds (also in detail.retryAfterSeconds)PartnerError
الترويسات
| الاسم | النوع | الوصف |
|---|---|---|
X-Request-Id | string | The id of this request: quote it to support. Send your own (8–64 of A-Z a-z 0-9 . _ -) to trace a call end to end. |
500INTERNAL_ERROR: retryable; quote the X-Request-Id if it persistsPartnerError
الترويسات
| الاسم | النوع | الوصف |
|---|---|---|
X-Request-Id | string | The id of this request: quote it to support. Send your own (8–64 of A-Z a-z 0-9 . _ -) to trace a call end to end. |
مثال الرد
[
{
"id": "7f3a2c10-5b8e-4d21-9c47-1a2b3c4d5e01",
"name": "string",
"url": "string",
"events": [
"order.created"
],
"branches": [
"string"
],
"pii": true,
"active": true,
"pausedAt": "2026-11-19T19:30:12+03:00",
"pausedReason": "string",
"secretHint": "string",
"createdAt": "2026-11-19T19:30:12+03:00",
"createdBy": "string",
"partnerId": "string",
"updatedAt": "2026-11-19T19:30:12+03:00",
"lastDeliveryAt": "2026-11-19T19:30:12+03:00",
"failureCount": 0,
"waiting": 0,
"dead": 0
}
]POSTSubscribe an address#
/partner/v1/webhooksScope webhooks:manage. Your own subscriptions on the Let’s Pizza webhook service: signed deliveries (X-LP-Signature: v1=<hex HMAC-SHA256(secret, "<X-LP-Timestamp>.<raw body>")>), retries after 1 min, 5 min, 30 min, 2 h and 12 h, a delivery log and replay. The branches are your key’s; whether the customer’s full details travel is your settings.customerData, not the request. The signing secret is returned this once (a replay of the same request answers the subscription with an empty secret: rotate it if it was lost).
curl -sS -X POST "$LP_BASE_URL/partner/v1/webhooks" \
-H "Authorization: Bearer $LP_API_KEY" \
-H "Idempotency-Key: $(uuidgen)" \
-H "Content-Type: application/json" \
--data '{
"name": "string",
"url": "string",
"events": [
"order.created"
],
"branches": [
"string"
],
"pii": true,
"active": true
}'المعاملات
| الاسم | الموضع | النوع | الوصف |
|---|---|---|---|
Idempotency-Key * | header | string | Your unique id of this request (≤ 128 characters). A repeat with the same key and body returns the first answer; the same key with another body is 422 IDEMPOTENCY_KEY_REUSED. |
جسم الطلب SaveWebhookRequest
namestringمطلوبالطول: 1 – 80
urlstringمطلوبالطول: 8 – 500
eventsWebhookEventType[]مطلوبالقيم:
"order.created""order.accepted""order.preparing""order.ready""order.out_for_delivery""order.delivered""order.picked_up""order.cancelled""order.rejected""order.failed_delivery""order.not_collected""order.ack_overdue""payment.succeeded""payment.refunded""invoice.issued""branch.closed""branch.opened""branch.busy""availability.changed""catalog.published""ping"العناصر: 1 – 21
branchesstring[]اختيارييقبل nullالعناصر: ≤ 200
piibooleanاختياريactivebooleanاختياري
الردود
201CreatedWebhookSecretIssued
الترويسات
| الاسم | النوع | الوصف |
|---|---|---|
X-Request-Id | string | The id of this request: quote it to support. Send your own (8–64 of A-Z a-z 0-9 . _ -) to trace a call end to end. |
RateLimit-Limit | integer | The key's requests per minute. |
RateLimit-Remaining | integer | Requests left in the current minute. |
RateLimit-Reset | integer | Seconds until the minute window resets. |
البنية
subscriptionWebhookSubscriptionمطلوبالحقول الداخلية (18)
idstringمطلوبالطول: 1 – 64
namestringمطلوبurlstringمطلوبeventsWebhookEventType[]مطلوبالقيم:
"order.created""order.accepted""order.preparing""order.ready""order.out_for_delivery""order.delivered""order.picked_up""order.cancelled""order.rejected""order.failed_delivery""order.not_collected""order.ack_overdue""payment.succeeded""payment.refunded""invoice.issued""branch.closed""branch.opened""branch.busy""availability.changed""catalog.published""ping"branchesstring[]مطلوبيقبل nullpiibooleanمطلوبactivebooleanمطلوبpausedAtstring<date-time>مطلوبيقبل nullpausedReasonstringمطلوبيقبل nullsecretHintstringمطلوبcreatedAtstring<date-time>مطلوبcreatedBystringمطلوبيقبل nullpartnerIdstringمطلوبيقبل nullupdatedAtstring<date-time>مطلوبlastDeliveryAtstring<date-time>مطلوبيقبل nullfailureCountintegerمطلوبالقيمة: ≥ 0
waitingintegerمطلوبالقيمة: ≥ 0
deadintegerمطلوبالقيمة: ≥ 0
secretstringمطلوب
400INVALID_REQUEST (field, detail.issues), IDEMPOTENCY_KEY_REQUIREDPartnerError
الترويسات
| الاسم | النوع | الوصف |
|---|---|---|
X-Request-Id | string | The id of this request: quote it to support. Send your own (8–64 of A-Z a-z 0-9 . _ -) to trace a call end to end. |
401UNAUTHENTICATED (no key, a wrong or revoked one), KEY_EXPIRED, KEY_ENVIRONMENT_MISMATCH (a test key on production or the other way round)PartnerError
الترويسات
| الاسم | النوع | الوصف |
|---|---|---|
X-Request-Id | string | The id of this request: quote it to support. Send your own (8–64 of A-Z a-z 0-9 . _ -) to trace a call end to end. |
403PARTNER_SUSPENDED, IP_NOT_ALLOWED, SCOPE_REQUIRED (detail.required lists the scopes), BRANCH_NOT_ALLOWEDPartnerError
الترويسات
| الاسم | النوع | الوصف |
|---|---|---|
X-Request-Id | string | The id of this request: quote it to support. Send your own (8–64 of A-Z a-z 0-9 . _ -) to trace a call end to end. |
422WEBHOOK_INVALID (detail.issues[] of {path, code}: URL_INVALID, URL_NOT_HTTPS, URL_PRIVATE_ADDRESS, URL_CREDENTIALS, EVENT_NOT_AVAILABLE, EVENT_REPEATED, BRANCHES_EMPTY, BRANCH_UNKNOWN), IDEMPOTENCY_KEY_REUSEDPartnerError
الترويسات
| الاسم | النوع | الوصف |
|---|---|---|
X-Request-Id | string | The id of this request: quote it to support. Send your own (8–64 of A-Z a-z 0-9 . _ -) to trace a call end to end. |
429RATE_LIMITED: wait Retry-After seconds (also in detail.retryAfterSeconds)PartnerError
الترويسات
| الاسم | النوع | الوصف |
|---|---|---|
X-Request-Id | string | The id of this request: quote it to support. Send your own (8–64 of A-Z a-z 0-9 . _ -) to trace a call end to end. |
500INTERNAL_ERROR: retryable; quote the X-Request-Id if it persistsPartnerError
الترويسات
| الاسم | النوع | الوصف |
|---|---|---|
X-Request-Id | string | The id of this request: quote it to support. Send your own (8–64 of A-Z a-z 0-9 . _ -) to trace a call end to end. |
مثال الرد
{
"subscription": {
"id": "7f3a2c10-5b8e-4d21-9c47-1a2b3c4d5e01",
"name": "string",
"url": "string",
"events": [
"order.created"
],
"branches": [
"string"
],
"pii": true,
"active": true,
"pausedAt": "2026-11-19T19:30:12+03:00",
"pausedReason": "string",
"secretHint": "string",
"createdAt": "2026-11-19T19:30:12+03:00",
"createdBy": "string",
"partnerId": "string",
"updatedAt": "2026-11-19T19:30:12+03:00",
"lastDeliveryAt": "2026-11-19T19:30:12+03:00",
"failureCount": 0,
"waiting": 0,
"dead": 0
},
"secret": "string"
}GETOne subscription#
/partner/v1/webhooks/{id}curl -sS "$LP_BASE_URL/partner/v1/webhooks/7f3a2c10-5b8e-4d21-9c47-1a2b3c4d5e01" \
-H "Authorization: Bearer $LP_API_KEY"المعاملات
| الاسم | الموضع | النوع | الوصف |
|---|---|---|---|
id * | path | string |
الردود
200OKWebhookSubscription
الترويسات
| الاسم | النوع | الوصف |
|---|---|---|
X-Request-Id | string | The id of this request: quote it to support. Send your own (8–64 of A-Z a-z 0-9 . _ -) to trace a call end to end. |
RateLimit-Limit | integer | The key's requests per minute. |
RateLimit-Remaining | integer | Requests left in the current minute. |
RateLimit-Reset | integer | Seconds until the minute window resets. |
البنية
idstringمطلوبالطول: 1 – 64
namestringمطلوبurlstringمطلوبeventsWebhookEventType[]مطلوبالقيم:
"order.created""order.accepted""order.preparing""order.ready""order.out_for_delivery""order.delivered""order.picked_up""order.cancelled""order.rejected""order.failed_delivery""order.not_collected""order.ack_overdue""payment.succeeded""payment.refunded""invoice.issued""branch.closed""branch.opened""branch.busy""availability.changed""catalog.published""ping"branchesstring[]مطلوبيقبل nullpiibooleanمطلوبactivebooleanمطلوبpausedAtstring<date-time>مطلوبيقبل nullpausedReasonstringمطلوبيقبل nullsecretHintstringمطلوبcreatedAtstring<date-time>مطلوبcreatedBystringمطلوبيقبل nullpartnerIdstringمطلوبيقبل nullupdatedAtstring<date-time>مطلوبlastDeliveryAtstring<date-time>مطلوبيقبل nullfailureCountintegerمطلوبالقيمة: ≥ 0
waitingintegerمطلوبالقيمة: ≥ 0
deadintegerمطلوبالقيمة: ≥ 0
401UNAUTHENTICATED (no key, a wrong or revoked one), KEY_EXPIRED, KEY_ENVIRONMENT_MISMATCH (a test key on production or the other way round)PartnerError
الترويسات
| الاسم | النوع | الوصف |
|---|---|---|
X-Request-Id | string | The id of this request: quote it to support. Send your own (8–64 of A-Z a-z 0-9 . _ -) to trace a call end to end. |
403PARTNER_SUSPENDED, IP_NOT_ALLOWED, SCOPE_REQUIRED (detail.required lists the scopes), BRANCH_NOT_ALLOWEDPartnerError
الترويسات
| الاسم | النوع | الوصف |
|---|---|---|
X-Request-Id | string | The id of this request: quote it to support. Send your own (8–64 of A-Z a-z 0-9 . _ -) to trace a call end to end. |
404WEBHOOK_NOT_FOUND: not one of your subscriptionsPartnerError
الترويسات
| الاسم | النوع | الوصف |
|---|---|---|
X-Request-Id | string | The id of this request: quote it to support. Send your own (8–64 of A-Z a-z 0-9 . _ -) to trace a call end to end. |
429RATE_LIMITED: wait Retry-After seconds (also in detail.retryAfterSeconds)PartnerError
الترويسات
| الاسم | النوع | الوصف |
|---|---|---|
X-Request-Id | string | The id of this request: quote it to support. Send your own (8–64 of A-Z a-z 0-9 . _ -) to trace a call end to end. |
500INTERNAL_ERROR: retryable; quote the X-Request-Id if it persistsPartnerError
الترويسات
| الاسم | النوع | الوصف |
|---|---|---|
X-Request-Id | string | The id of this request: quote it to support. Send your own (8–64 of A-Z a-z 0-9 . _ -) to trace a call end to end. |
مثال الرد
{
"id": "7f3a2c10-5b8e-4d21-9c47-1a2b3c4d5e01",
"name": "string",
"url": "string",
"events": [
"order.created"
],
"branches": [
"string"
],
"pii": true,
"active": true,
"pausedAt": "2026-11-19T19:30:12+03:00",
"pausedReason": "string",
"secretHint": "string",
"createdAt": "2026-11-19T19:30:12+03:00",
"createdBy": "string",
"partnerId": "string",
"updatedAt": "2026-11-19T19:30:12+03:00",
"lastDeliveryAt": "2026-11-19T19:30:12+03:00",
"failureCount": 0,
"waiting": 0,
"dead": 0
}PUTChange a subscription#
/partner/v1/webhooks/{id}curl -sS -X PUT "$LP_BASE_URL/partner/v1/webhooks/7f3a2c10-5b8e-4d21-9c47-1a2b3c4d5e01" \
-H "Authorization: Bearer $LP_API_KEY" \
-H "Content-Type: application/json" \
--data '{
"name": "string",
"url": "string",
"events": [
"order.created"
],
"branches": [
"string"
],
"pii": true,
"active": true
}'المعاملات
| الاسم | الموضع | النوع | الوصف |
|---|---|---|---|
id * | path | string |
جسم الطلب SaveWebhookRequest
namestringمطلوبالطول: 1 – 80
urlstringمطلوبالطول: 8 – 500
eventsWebhookEventType[]مطلوبالقيم:
"order.created""order.accepted""order.preparing""order.ready""order.out_for_delivery""order.delivered""order.picked_up""order.cancelled""order.rejected""order.failed_delivery""order.not_collected""order.ack_overdue""payment.succeeded""payment.refunded""invoice.issued""branch.closed""branch.opened""branch.busy""availability.changed""catalog.published""ping"العناصر: 1 – 21
branchesstring[]اختيارييقبل nullالعناصر: ≤ 200
piibooleanاختياريactivebooleanاختياري
الردود
200OKWebhookSubscription
الترويسات
| الاسم | النوع | الوصف |
|---|---|---|
X-Request-Id | string | The id of this request: quote it to support. Send your own (8–64 of A-Z a-z 0-9 . _ -) to trace a call end to end. |
RateLimit-Limit | integer | The key's requests per minute. |
RateLimit-Remaining | integer | Requests left in the current minute. |
RateLimit-Reset | integer | Seconds until the minute window resets. |
البنية
idstringمطلوبالطول: 1 – 64
namestringمطلوبurlstringمطلوبeventsWebhookEventType[]مطلوبالقيم:
"order.created""order.accepted""order.preparing""order.ready""order.out_for_delivery""order.delivered""order.picked_up""order.cancelled""order.rejected""order.failed_delivery""order.not_collected""order.ack_overdue""payment.succeeded""payment.refunded""invoice.issued""branch.closed""branch.opened""branch.busy""availability.changed""catalog.published""ping"branchesstring[]مطلوبيقبل nullpiibooleanمطلوبactivebooleanمطلوبpausedAtstring<date-time>مطلوبيقبل nullpausedReasonstringمطلوبيقبل nullsecretHintstringمطلوبcreatedAtstring<date-time>مطلوبcreatedBystringمطلوبيقبل nullpartnerIdstringمطلوبيقبل nullupdatedAtstring<date-time>مطلوبlastDeliveryAtstring<date-time>مطلوبيقبل nullfailureCountintegerمطلوبالقيمة: ≥ 0
waitingintegerمطلوبالقيمة: ≥ 0
deadintegerمطلوبالقيمة: ≥ 0
401UNAUTHENTICATED (no key, a wrong or revoked one), KEY_EXPIRED, KEY_ENVIRONMENT_MISMATCH (a test key on production or the other way round)PartnerError
الترويسات
| الاسم | النوع | الوصف |
|---|---|---|
X-Request-Id | string | The id of this request: quote it to support. Send your own (8–64 of A-Z a-z 0-9 . _ -) to trace a call end to end. |
403PARTNER_SUSPENDED, IP_NOT_ALLOWED, SCOPE_REQUIRED (detail.required lists the scopes), BRANCH_NOT_ALLOWEDPartnerError
الترويسات
| الاسم | النوع | الوصف |
|---|---|---|
X-Request-Id | string | The id of this request: quote it to support. Send your own (8–64 of A-Z a-z 0-9 . _ -) to trace a call end to end. |
404WEBHOOK_NOT_FOUND: not one of your subscriptionsPartnerError
الترويسات
| الاسم | النوع | الوصف |
|---|---|---|
X-Request-Id | string | The id of this request: quote it to support. Send your own (8–64 of A-Z a-z 0-9 . _ -) to trace a call end to end. |
422WEBHOOK_INVALID (detail.issues[] of {path, code}: URL_INVALID, URL_NOT_HTTPS, URL_PRIVATE_ADDRESS, URL_CREDENTIALS, EVENT_NOT_AVAILABLE, EVENT_REPEATED, BRANCHES_EMPTY, BRANCH_UNKNOWN), IDEMPOTENCY_KEY_REUSEDPartnerError
الترويسات
| الاسم | النوع | الوصف |
|---|---|---|
X-Request-Id | string | The id of this request: quote it to support. Send your own (8–64 of A-Z a-z 0-9 . _ -) to trace a call end to end. |
429RATE_LIMITED: wait Retry-After seconds (also in detail.retryAfterSeconds)PartnerError
الترويسات
| الاسم | النوع | الوصف |
|---|---|---|
X-Request-Id | string | The id of this request: quote it to support. Send your own (8–64 of A-Z a-z 0-9 . _ -) to trace a call end to end. |
500INTERNAL_ERROR: retryable; quote the X-Request-Id if it persistsPartnerError
الترويسات
| الاسم | النوع | الوصف |
|---|---|---|
X-Request-Id | string | The id of this request: quote it to support. Send your own (8–64 of A-Z a-z 0-9 . _ -) to trace a call end to end. |
مثال الرد
{
"id": "7f3a2c10-5b8e-4d21-9c47-1a2b3c4d5e01",
"name": "string",
"url": "string",
"events": [
"order.created"
],
"branches": [
"string"
],
"pii": true,
"active": true,
"pausedAt": "2026-11-19T19:30:12+03:00",
"pausedReason": "string",
"secretHint": "string",
"createdAt": "2026-11-19T19:30:12+03:00",
"createdBy": "string",
"partnerId": "string",
"updatedAt": "2026-11-19T19:30:12+03:00",
"lastDeliveryAt": "2026-11-19T19:30:12+03:00",
"failureCount": 0,
"waiting": 0,
"dead": 0
}DELRemove a subscription and its log#
/partner/v1/webhooks/{id}curl -sS -X DELETE "$LP_BASE_URL/partner/v1/webhooks/7f3a2c10-5b8e-4d21-9c47-1a2b3c4d5e01" \
-H "Authorization: Bearer $LP_API_KEY"المعاملات
| الاسم | الموضع | النوع | الوصف |
|---|---|---|---|
id * | path | string |
الردود
204Removed
401UNAUTHENTICATED (no key, a wrong or revoked one), KEY_EXPIRED, KEY_ENVIRONMENT_MISMATCH (a test key on production or the other way round)PartnerError
الترويسات
| الاسم | النوع | الوصف |
|---|---|---|
X-Request-Id | string | The id of this request: quote it to support. Send your own (8–64 of A-Z a-z 0-9 . _ -) to trace a call end to end. |
403PARTNER_SUSPENDED, IP_NOT_ALLOWED, SCOPE_REQUIRED (detail.required lists the scopes), BRANCH_NOT_ALLOWEDPartnerError
الترويسات
| الاسم | النوع | الوصف |
|---|---|---|
X-Request-Id | string | The id of this request: quote it to support. Send your own (8–64 of A-Z a-z 0-9 . _ -) to trace a call end to end. |
404WEBHOOK_NOT_FOUND: not one of your subscriptionsPartnerError
الترويسات
| الاسم | النوع | الوصف |
|---|---|---|
X-Request-Id | string | The id of this request: quote it to support. Send your own (8–64 of A-Z a-z 0-9 . _ -) to trace a call end to end. |
429RATE_LIMITED: wait Retry-After seconds (also in detail.retryAfterSeconds)PartnerError
الترويسات
| الاسم | النوع | الوصف |
|---|---|---|
X-Request-Id | string | The id of this request: quote it to support. Send your own (8–64 of A-Z a-z 0-9 . _ -) to trace a call end to end. |
500INTERNAL_ERROR: retryable; quote the X-Request-Id if it persistsPartnerError
الترويسات
| الاسم | النوع | الوصف |
|---|---|---|
X-Request-Id | string | The id of this request: quote it to support. Send your own (8–64 of A-Z a-z 0-9 . _ -) to trace a call end to end. |
POSTA new signing secret#
/partner/v1/webhooks/{id}/secretReturned this once; the old secret stops working at once.
curl -sS -X POST "$LP_BASE_URL/partner/v1/webhooks/7f3a2c10-5b8e-4d21-9c47-1a2b3c4d5e01/secret" \
-H "Authorization: Bearer $LP_API_KEY"المعاملات
| الاسم | الموضع | النوع | الوصف |
|---|---|---|---|
id * | path | string |
الردود
201CreatedWebhookSecretIssued
الترويسات
| الاسم | النوع | الوصف |
|---|---|---|
X-Request-Id | string | The id of this request: quote it to support. Send your own (8–64 of A-Z a-z 0-9 . _ -) to trace a call end to end. |
RateLimit-Limit | integer | The key's requests per minute. |
RateLimit-Remaining | integer | Requests left in the current minute. |
RateLimit-Reset | integer | Seconds until the minute window resets. |
البنية
subscriptionWebhookSubscriptionمطلوبالحقول الداخلية (18)
idstringمطلوبالطول: 1 – 64
namestringمطلوبurlstringمطلوبeventsWebhookEventType[]مطلوبالقيم:
"order.created""order.accepted""order.preparing""order.ready""order.out_for_delivery""order.delivered""order.picked_up""order.cancelled""order.rejected""order.failed_delivery""order.not_collected""order.ack_overdue""payment.succeeded""payment.refunded""invoice.issued""branch.closed""branch.opened""branch.busy""availability.changed""catalog.published""ping"branchesstring[]مطلوبيقبل nullpiibooleanمطلوبactivebooleanمطلوبpausedAtstring<date-time>مطلوبيقبل nullpausedReasonstringمطلوبيقبل nullsecretHintstringمطلوبcreatedAtstring<date-time>مطلوبcreatedBystringمطلوبيقبل nullpartnerIdstringمطلوبيقبل nullupdatedAtstring<date-time>مطلوبlastDeliveryAtstring<date-time>مطلوبيقبل nullfailureCountintegerمطلوبالقيمة: ≥ 0
waitingintegerمطلوبالقيمة: ≥ 0
deadintegerمطلوبالقيمة: ≥ 0
secretstringمطلوب
401UNAUTHENTICATED (no key, a wrong or revoked one), KEY_EXPIRED, KEY_ENVIRONMENT_MISMATCH (a test key on production or the other way round)PartnerError
الترويسات
| الاسم | النوع | الوصف |
|---|---|---|
X-Request-Id | string | The id of this request: quote it to support. Send your own (8–64 of A-Z a-z 0-9 . _ -) to trace a call end to end. |
403PARTNER_SUSPENDED, IP_NOT_ALLOWED, SCOPE_REQUIRED (detail.required lists the scopes), BRANCH_NOT_ALLOWEDPartnerError
الترويسات
| الاسم | النوع | الوصف |
|---|---|---|
X-Request-Id | string | The id of this request: quote it to support. Send your own (8–64 of A-Z a-z 0-9 . _ -) to trace a call end to end. |
404WEBHOOK_NOT_FOUND: not one of your subscriptionsPartnerError
الترويسات
| الاسم | النوع | الوصف |
|---|---|---|
X-Request-Id | string | The id of this request: quote it to support. Send your own (8–64 of A-Z a-z 0-9 . _ -) to trace a call end to end. |
429RATE_LIMITED: wait Retry-After seconds (also in detail.retryAfterSeconds)PartnerError
الترويسات
| الاسم | النوع | الوصف |
|---|---|---|
X-Request-Id | string | The id of this request: quote it to support. Send your own (8–64 of A-Z a-z 0-9 . _ -) to trace a call end to end. |
500INTERNAL_ERROR: retryable; quote the X-Request-Id if it persistsPartnerError
الترويسات
| الاسم | النوع | الوصف |
|---|---|---|
X-Request-Id | string | The id of this request: quote it to support. Send your own (8–64 of A-Z a-z 0-9 . _ -) to trace a call end to end. |
مثال الرد
{
"subscription": {
"id": "7f3a2c10-5b8e-4d21-9c47-1a2b3c4d5e01",
"name": "string",
"url": "string",
"events": [
"order.created"
],
"branches": [
"string"
],
"pii": true,
"active": true,
"pausedAt": "2026-11-19T19:30:12+03:00",
"pausedReason": "string",
"secretHint": "string",
"createdAt": "2026-11-19T19:30:12+03:00",
"createdBy": "string",
"partnerId": "string",
"updatedAt": "2026-11-19T19:30:12+03:00",
"lastDeliveryAt": "2026-11-19T19:30:12+03:00",
"failureCount": 0,
"waiting": 0,
"dead": 0
},
"secret": "string"
}POSTSend a signed ping now#
/partner/v1/webhooks/{id}/testOne attempt, logged like any delivery, never retried.
curl -sS -X POST "$LP_BASE_URL/partner/v1/webhooks/7f3a2c10-5b8e-4d21-9c47-1a2b3c4d5e01/test" \
-H "Authorization: Bearer $LP_API_KEY"المعاملات
| الاسم | الموضع | النوع | الوصف |
|---|---|---|---|
id * | path | string |
الردود
201SentWebhookDelivery
الترويسات
| الاسم | النوع | الوصف |
|---|---|---|
X-Request-Id | string | The id of this request: quote it to support. Send your own (8–64 of A-Z a-z 0-9 . _ -) to trace a call end to end. |
RateLimit-Limit | integer | The key's requests per minute. |
RateLimit-Remaining | integer | Requests left in the current minute. |
RateLimit-Reset | integer | Seconds until the minute window resets. |
البنية
idstringمطلوبالطول: 1 – 64
subscriptionIdstringمطلوبالطول: 1 – 64
eventIdstringمطلوبيقبل nulleventTypeWebhookEventTypeمطلوبالقيم:
"order.created""order.accepted""order.preparing""order.ready""order.out_for_delivery""order.delivered""order.picked_up""order.cancelled""order.rejected""order.failed_delivery""order.not_collected""order.ack_overdue""payment.succeeded""payment.refunded""invoice.issued""branch.closed""branch.opened""branch.busy""availability.changed""catalog.published""ping"subjectstringمطلوبيقبل nullbranchIdstringمطلوبيقبل nullattemptintegerمطلوبالقيمة: ≥ 0
statusWebhookDeliveryStatusمطلوبالقيم:
"pending""delivered""failed""dead"httpStatusintegerمطلوبيقبل nulldurationMsintegerمطلوبيقبل nullerrorstringمطلوبيقبل nullnextAtstring<date-time>مطلوبيقبل nullcreatedAtstring<date-time>مطلوبlastAttemptAtstring<date-time>مطلوبيقبل nulldeliveredAtstring<date-time>مطلوبيقبل nullreplayOfstringمطلوبيقبل null
401UNAUTHENTICATED (no key, a wrong or revoked one), KEY_EXPIRED, KEY_ENVIRONMENT_MISMATCH (a test key on production or the other way round)PartnerError
الترويسات
| الاسم | النوع | الوصف |
|---|---|---|
X-Request-Id | string | The id of this request: quote it to support. Send your own (8–64 of A-Z a-z 0-9 . _ -) to trace a call end to end. |
403PARTNER_SUSPENDED, IP_NOT_ALLOWED, SCOPE_REQUIRED (detail.required lists the scopes), BRANCH_NOT_ALLOWEDPartnerError
الترويسات
| الاسم | النوع | الوصف |
|---|---|---|
X-Request-Id | string | The id of this request: quote it to support. Send your own (8–64 of A-Z a-z 0-9 . _ -) to trace a call end to end. |
404WEBHOOK_NOT_FOUND: not one of your subscriptionsPartnerError
الترويسات
| الاسم | النوع | الوصف |
|---|---|---|
X-Request-Id | string | The id of this request: quote it to support. Send your own (8–64 of A-Z a-z 0-9 . _ -) to trace a call end to end. |
429RATE_LIMITED: wait Retry-After seconds (also in detail.retryAfterSeconds)PartnerError
الترويسات
| الاسم | النوع | الوصف |
|---|---|---|
X-Request-Id | string | The id of this request: quote it to support. Send your own (8–64 of A-Z a-z 0-9 . _ -) to trace a call end to end. |
500INTERNAL_ERROR: retryable; quote the X-Request-Id if it persistsPartnerError
الترويسات
| الاسم | النوع | الوصف |
|---|---|---|
X-Request-Id | string | The id of this request: quote it to support. Send your own (8–64 of A-Z a-z 0-9 . _ -) to trace a call end to end. |
مثال الرد
{
"id": "7f3a2c10-5b8e-4d21-9c47-1a2b3c4d5e01",
"subscriptionId": "string",
"eventId": "BC-EVT-000985",
"eventType": "order.created",
"subject": "string",
"branchId": "28",
"attempt": 0,
"status": "pending",
"httpStatus": 0,
"durationMs": 0,
"error": "string",
"nextAt": "2026-11-19T19:30:12+03:00",
"createdAt": "2026-11-19T19:30:12+03:00",
"lastAttemptAt": "2026-11-19T19:30:12+03:00",
"deliveredAt": "2026-11-19T19:30:12+03:00",
"replayOf": "string"
}GETThe delivery log#
/partner/v1/webhooks/{id}/deliveriescurl -sS "$LP_BASE_URL/partner/v1/webhooks/7f3a2c10-5b8e-4d21-9c47-1a2b3c4d5e01/deliveries" \
-H "Authorization: Bearer $LP_API_KEY"المعاملات
| الاسم | الموضع | النوع | الوصف |
|---|---|---|---|
id * | path | string | |
status | query | string | Comma-separated: pending, delivered, failed, dead. |
before | query | string | |
limit | query | integer |
الردود
200OKWebhookDeliveryPage
الترويسات
| الاسم | النوع | الوصف |
|---|---|---|
X-Request-Id | string | The id of this request: quote it to support. Send your own (8–64 of A-Z a-z 0-9 . _ -) to trace a call end to end. |
RateLimit-Limit | integer | The key's requests per minute. |
RateLimit-Remaining | integer | Requests left in the current minute. |
RateLimit-Reset | integer | Seconds until the minute window resets. |
البنية
deliveriesWebhookDelivery[]مطلوبالحقول الداخلية (16)
idstringمطلوبالطول: 1 – 64
subscriptionIdstringمطلوبالطول: 1 – 64
eventIdstringمطلوبيقبل nulleventTypeWebhookEventTypeمطلوبالقيم:
"order.created""order.accepted""order.preparing""order.ready""order.out_for_delivery""order.delivered""order.picked_up""order.cancelled""order.rejected""order.failed_delivery""order.not_collected""order.ack_overdue""payment.succeeded""payment.refunded""invoice.issued""branch.closed""branch.opened""branch.busy""availability.changed""catalog.published""ping"subjectstringمطلوبيقبل nullbranchIdstringمطلوبيقبل nullattemptintegerمطلوبالقيمة: ≥ 0
statusWebhookDeliveryStatusمطلوبالقيم:
"pending""delivered""failed""dead"httpStatusintegerمطلوبيقبل nulldurationMsintegerمطلوبيقبل nullerrorstringمطلوبيقبل nullnextAtstring<date-time>مطلوبيقبل nullcreatedAtstring<date-time>مطلوبlastAttemptAtstring<date-time>مطلوبيقبل nulldeliveredAtstring<date-time>مطلوبيقبل nullreplayOfstringمطلوبيقبل null
nextBeforestringاختياري
401UNAUTHENTICATED (no key, a wrong or revoked one), KEY_EXPIRED, KEY_ENVIRONMENT_MISMATCH (a test key on production or the other way round)PartnerError
الترويسات
| الاسم | النوع | الوصف |
|---|---|---|
X-Request-Id | string | The id of this request: quote it to support. Send your own (8–64 of A-Z a-z 0-9 . _ -) to trace a call end to end. |
403PARTNER_SUSPENDED, IP_NOT_ALLOWED, SCOPE_REQUIRED (detail.required lists the scopes), BRANCH_NOT_ALLOWEDPartnerError
الترويسات
| الاسم | النوع | الوصف |
|---|---|---|
X-Request-Id | string | The id of this request: quote it to support. Send your own (8–64 of A-Z a-z 0-9 . _ -) to trace a call end to end. |
404WEBHOOK_NOT_FOUND: not one of your subscriptionsPartnerError
الترويسات
| الاسم | النوع | الوصف |
|---|---|---|
X-Request-Id | string | The id of this request: quote it to support. Send your own (8–64 of A-Z a-z 0-9 . _ -) to trace a call end to end. |
429RATE_LIMITED: wait Retry-After seconds (also in detail.retryAfterSeconds)PartnerError
الترويسات
| الاسم | النوع | الوصف |
|---|---|---|
X-Request-Id | string | The id of this request: quote it to support. Send your own (8–64 of A-Z a-z 0-9 . _ -) to trace a call end to end. |
500INTERNAL_ERROR: retryable; quote the X-Request-Id if it persistsPartnerError
الترويسات
| الاسم | النوع | الوصف |
|---|---|---|
X-Request-Id | string | The id of this request: quote it to support. Send your own (8–64 of A-Z a-z 0-9 . _ -) to trace a call end to end. |
مثال الرد
{
"deliveries": [
{
"id": "7f3a2c10-5b8e-4d21-9c47-1a2b3c4d5e01",
"subscriptionId": "string",
"eventId": "BC-EVT-000985",
"eventType": "order.created",
"subject": "string",
"branchId": "28",
"attempt": 0,
"status": "pending",
"httpStatus": 0,
"durationMs": 0,
"error": "string",
"nextAt": "2026-11-19T19:30:12+03:00",
"createdAt": "2026-11-19T19:30:12+03:00",
"lastAttemptAt": "2026-11-19T19:30:12+03:00",
"deliveredAt": "2026-11-19T19:30:12+03:00",
"replayOf": "string"
}
],
"nextBefore": "string"
}POSTSend a delivery again#
/partner/v1/webhooks/{id}/deliveries/{deliveryId}/replayA new delivery of the same envelope (same id: deduplicate on it), sent by the worker.
curl -sS -X POST "$LP_BASE_URL/partner/v1/webhooks/7f3a2c10-5b8e-4d21-9c47-1a2b3c4d5e01/deliveries/string/replay" \
-H "Authorization: Bearer $LP_API_KEY"المعاملات
| الاسم | الموضع | النوع | الوصف |
|---|---|---|---|
id * | path | string | |
deliveryId * | path | string |
الردود
201QueuedWebhookDelivery
الترويسات
| الاسم | النوع | الوصف |
|---|---|---|
X-Request-Id | string | The id of this request: quote it to support. Send your own (8–64 of A-Z a-z 0-9 . _ -) to trace a call end to end. |
RateLimit-Limit | integer | The key's requests per minute. |
RateLimit-Remaining | integer | Requests left in the current minute. |
RateLimit-Reset | integer | Seconds until the minute window resets. |
البنية
idstringمطلوبالطول: 1 – 64
subscriptionIdstringمطلوبالطول: 1 – 64
eventIdstringمطلوبيقبل nulleventTypeWebhookEventTypeمطلوبالقيم:
"order.created""order.accepted""order.preparing""order.ready""order.out_for_delivery""order.delivered""order.picked_up""order.cancelled""order.rejected""order.failed_delivery""order.not_collected""order.ack_overdue""payment.succeeded""payment.refunded""invoice.issued""branch.closed""branch.opened""branch.busy""availability.changed""catalog.published""ping"subjectstringمطلوبيقبل nullbranchIdstringمطلوبيقبل nullattemptintegerمطلوبالقيمة: ≥ 0
statusWebhookDeliveryStatusمطلوبالقيم:
"pending""delivered""failed""dead"httpStatusintegerمطلوبيقبل nulldurationMsintegerمطلوبيقبل nullerrorstringمطلوبيقبل nullnextAtstring<date-time>مطلوبيقبل nullcreatedAtstring<date-time>مطلوبlastAttemptAtstring<date-time>مطلوبيقبل nulldeliveredAtstring<date-time>مطلوبيقبل nullreplayOfstringمطلوبيقبل null
401UNAUTHENTICATED (no key, a wrong or revoked one), KEY_EXPIRED, KEY_ENVIRONMENT_MISMATCH (a test key on production or the other way round)PartnerError
الترويسات
| الاسم | النوع | الوصف |
|---|---|---|
X-Request-Id | string | The id of this request: quote it to support. Send your own (8–64 of A-Z a-z 0-9 . _ -) to trace a call end to end. |
403PARTNER_SUSPENDED, IP_NOT_ALLOWED, SCOPE_REQUIRED (detail.required lists the scopes), BRANCH_NOT_ALLOWEDPartnerError
الترويسات
| الاسم | النوع | الوصف |
|---|---|---|
X-Request-Id | string | The id of this request: quote it to support. Send your own (8–64 of A-Z a-z 0-9 . _ -) to trace a call end to end. |
404WEBHOOK_NOT_FOUND: not one of your subscriptionsPartnerError
الترويسات
| الاسم | النوع | الوصف |
|---|---|---|
X-Request-Id | string | The id of this request: quote it to support. Send your own (8–64 of A-Z a-z 0-9 . _ -) to trace a call end to end. |
429RATE_LIMITED: wait Retry-After seconds (also in detail.retryAfterSeconds)PartnerError
الترويسات
| الاسم | النوع | الوصف |
|---|---|---|
X-Request-Id | string | The id of this request: quote it to support. Send your own (8–64 of A-Z a-z 0-9 . _ -) to trace a call end to end. |
500INTERNAL_ERROR: retryable; quote the X-Request-Id if it persistsPartnerError
الترويسات
| الاسم | النوع | الوصف |
|---|---|---|
X-Request-Id | string | The id of this request: quote it to support. Send your own (8–64 of A-Z a-z 0-9 . _ -) to trace a call end to end. |
مثال الرد
{
"id": "7f3a2c10-5b8e-4d21-9c47-1a2b3c4d5e01",
"subscriptionId": "string",
"eventId": "BC-EVT-000985",
"eventType": "order.created",
"subject": "string",
"branchId": "28",
"attempt": 0,
"status": "pending",
"httpStatus": 0,
"durationMs": 0,
"error": "string",
"nextAt": "2026-11-19T19:30:12+03:00",
"createdAt": "2026-11-19T19:30:12+03:00",
"lastAttemptAt": "2026-11-19T19:30:12+03:00",
"deliveredAt": "2026-11-19T19:30:12+03:00",
"replayOf": "string"
}