Let's Pizza Developersv1.0.0

API reference

Webhooks

Your own signed webhook subscriptions: events pushed to your address instead of polling.

GETYour subscriptions#

GET/partner/v1/webhooks

Scope 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.

Authentication
Partner key in the Authorization header
Scopes required
webhooks:manage
curl -sS "$LP_BASE_URL/partner/v1/webhooks" \
  -H "Authorization: Bearer $LP_API_KEY"

Responses

200OKWebhookSubscription[]

Headers

NameTypeDescription
X-Request-IdstringThe 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-LimitintegerThe key's requests per minute.
RateLimit-RemainingintegerRequests left in the current minute.
RateLimit-ResetintegerSeconds until the minute window resets.

Schema

401UNAUTHENTICATED (no key, a wrong or revoked one), KEY_EXPIRED, KEY_ENVIRONMENT_MISMATCH (a test key on production or the other way round)PartnerError

Headers

NameTypeDescription
X-Request-IdstringThe 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

Headers

NameTypeDescription
X-Request-IdstringThe 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

Headers

NameTypeDescription
X-Request-IdstringThe 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

Headers

NameTypeDescription
X-Request-IdstringThe 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.

Example response

200 · JSON
[
  {
    "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#

POST/partner/v1/webhooks

Scope 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).

Authentication
Partner key in the Authorization header
Scopes required
webhooks:manage
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
}'

Parameters

NameInTypeDescription
Idempotency-Key *headerstringYour 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.

Request body SaveWebhookRequest

  • namestringrequired

    length 1 – 80

  • urlstringrequired

    length 8 – 500

  • eventsWebhookEventType[]required

    Values: "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"

    items 1 – 21

  • branchesstring[]optionalnullable

    items ≤ 200

  • piibooleanoptional
  • activebooleanoptional

Responses

201CreatedWebhookSecretIssued

Headers

NameTypeDescription
X-Request-IdstringThe 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-LimitintegerThe key's requests per minute.
RateLimit-RemainingintegerRequests left in the current minute.
RateLimit-ResetintegerSeconds until the minute window resets.

Schema

  • subscriptionWebhookSubscriptionrequired
    Child attributes (18)
    • idstringrequired

      length 1 – 64

    • namestringrequired
    • urlstringrequired
    • eventsWebhookEventType[]required

      Values: "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[]requirednullable
    • piibooleanrequired
    • activebooleanrequired
    • pausedAtstring<date-time>requirednullable
    • pausedReasonstringrequirednullable
    • secretHintstringrequired
    • createdAtstring<date-time>required
    • createdBystringrequirednullable
    • partnerIdstringrequirednullable
    • updatedAtstring<date-time>required
    • lastDeliveryAtstring<date-time>requirednullable
    • failureCountintegerrequired

      value ≥ 0

    • waitingintegerrequired

      value ≥ 0

    • deadintegerrequired

      value ≥ 0

  • secretstringrequired
400INVALID_REQUEST (field, detail.issues), IDEMPOTENCY_KEY_REQUIREDPartnerError

Headers

NameTypeDescription
X-Request-IdstringThe 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

Headers

NameTypeDescription
X-Request-IdstringThe 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

Headers

NameTypeDescription
X-Request-IdstringThe 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

Headers

NameTypeDescription
X-Request-IdstringThe 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

Headers

NameTypeDescription
X-Request-IdstringThe 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

Headers

NameTypeDescription
X-Request-IdstringThe 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.

Example response

201 · WebhookSecretIssued
{
  "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#

GET/partner/v1/webhooks/{id}
Authentication
Partner key in the Authorization header
Scopes required
Any valid key
curl -sS "$LP_BASE_URL/partner/v1/webhooks/7f3a2c10-5b8e-4d21-9c47-1a2b3c4d5e01" \
  -H "Authorization: Bearer $LP_API_KEY"

Parameters

NameInTypeDescription
id *pathstring

Responses

200OKWebhookSubscription

Headers

NameTypeDescription
X-Request-IdstringThe 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-LimitintegerThe key's requests per minute.
RateLimit-RemainingintegerRequests left in the current minute.
RateLimit-ResetintegerSeconds until the minute window resets.

Schema

  • idstringrequired

    length 1 – 64

  • namestringrequired
  • urlstringrequired
  • eventsWebhookEventType[]required

    Values: "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[]requirednullable
  • piibooleanrequired
  • activebooleanrequired
  • pausedAtstring<date-time>requirednullable
  • pausedReasonstringrequirednullable
  • secretHintstringrequired
  • createdAtstring<date-time>required
  • createdBystringrequirednullable
  • partnerIdstringrequirednullable
  • updatedAtstring<date-time>required
  • lastDeliveryAtstring<date-time>requirednullable
  • failureCountintegerrequired

    value ≥ 0

  • waitingintegerrequired

    value ≥ 0

  • deadintegerrequired

    value ≥ 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

Headers

NameTypeDescription
X-Request-IdstringThe 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

Headers

NameTypeDescription
X-Request-IdstringThe 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

Headers

NameTypeDescription
X-Request-IdstringThe 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

Headers

NameTypeDescription
X-Request-IdstringThe 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

Headers

NameTypeDescription
X-Request-IdstringThe 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.

Example response

200 · WebhookSubscription
{
  "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#

PUT/partner/v1/webhooks/{id}
Authentication
Partner key in the Authorization header
Scopes required
Any valid key
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
}'

Parameters

NameInTypeDescription
id *pathstring

Request body SaveWebhookRequest

  • namestringrequired

    length 1 – 80

  • urlstringrequired

    length 8 – 500

  • eventsWebhookEventType[]required

    Values: "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"

    items 1 – 21

  • branchesstring[]optionalnullable

    items ≤ 200

  • piibooleanoptional
  • activebooleanoptional

Responses

200OKWebhookSubscription

Headers

NameTypeDescription
X-Request-IdstringThe 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-LimitintegerThe key's requests per minute.
RateLimit-RemainingintegerRequests left in the current minute.
RateLimit-ResetintegerSeconds until the minute window resets.

Schema

  • idstringrequired

    length 1 – 64

  • namestringrequired
  • urlstringrequired
  • eventsWebhookEventType[]required

    Values: "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[]requirednullable
  • piibooleanrequired
  • activebooleanrequired
  • pausedAtstring<date-time>requirednullable
  • pausedReasonstringrequirednullable
  • secretHintstringrequired
  • createdAtstring<date-time>required
  • createdBystringrequirednullable
  • partnerIdstringrequirednullable
  • updatedAtstring<date-time>required
  • lastDeliveryAtstring<date-time>requirednullable
  • failureCountintegerrequired

    value ≥ 0

  • waitingintegerrequired

    value ≥ 0

  • deadintegerrequired

    value ≥ 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

Headers

NameTypeDescription
X-Request-IdstringThe 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

Headers

NameTypeDescription
X-Request-IdstringThe 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

Headers

NameTypeDescription
X-Request-IdstringThe 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

Headers

NameTypeDescription
X-Request-IdstringThe 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

Headers

NameTypeDescription
X-Request-IdstringThe 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

Headers

NameTypeDescription
X-Request-IdstringThe 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.

Example response

200 · WebhookSubscription
{
  "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#

DEL/partner/v1/webhooks/{id}
Authentication
Partner key in the Authorization header
Scopes required
Any valid key
curl -sS -X DELETE "$LP_BASE_URL/partner/v1/webhooks/7f3a2c10-5b8e-4d21-9c47-1a2b3c4d5e01" \
  -H "Authorization: Bearer $LP_API_KEY"

Parameters

NameInTypeDescription
id *pathstring

Responses

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

Headers

NameTypeDescription
X-Request-IdstringThe 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

Headers

NameTypeDescription
X-Request-IdstringThe 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

Headers

NameTypeDescription
X-Request-IdstringThe 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

Headers

NameTypeDescription
X-Request-IdstringThe 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

Headers

NameTypeDescription
X-Request-IdstringThe 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#

POST/partner/v1/webhooks/{id}/secret

Returned this once; the old secret stops working at once.

Authentication
Partner key in the Authorization header
Scopes required
Any valid key
curl -sS -X POST "$LP_BASE_URL/partner/v1/webhooks/7f3a2c10-5b8e-4d21-9c47-1a2b3c4d5e01/secret" \
  -H "Authorization: Bearer $LP_API_KEY"

Parameters

NameInTypeDescription
id *pathstring

Responses

201CreatedWebhookSecretIssued

Headers

NameTypeDescription
X-Request-IdstringThe 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-LimitintegerThe key's requests per minute.
RateLimit-RemainingintegerRequests left in the current minute.
RateLimit-ResetintegerSeconds until the minute window resets.

Schema

  • subscriptionWebhookSubscriptionrequired
    Child attributes (18)
    • idstringrequired

      length 1 – 64

    • namestringrequired
    • urlstringrequired
    • eventsWebhookEventType[]required

      Values: "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[]requirednullable
    • piibooleanrequired
    • activebooleanrequired
    • pausedAtstring<date-time>requirednullable
    • pausedReasonstringrequirednullable
    • secretHintstringrequired
    • createdAtstring<date-time>required
    • createdBystringrequirednullable
    • partnerIdstringrequirednullable
    • updatedAtstring<date-time>required
    • lastDeliveryAtstring<date-time>requirednullable
    • failureCountintegerrequired

      value ≥ 0

    • waitingintegerrequired

      value ≥ 0

    • deadintegerrequired

      value ≥ 0

  • secretstringrequired
401UNAUTHENTICATED (no key, a wrong or revoked one), KEY_EXPIRED, KEY_ENVIRONMENT_MISMATCH (a test key on production or the other way round)PartnerError

Headers

NameTypeDescription
X-Request-IdstringThe 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

Headers

NameTypeDescription
X-Request-IdstringThe 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

Headers

NameTypeDescription
X-Request-IdstringThe 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

Headers

NameTypeDescription
X-Request-IdstringThe 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

Headers

NameTypeDescription
X-Request-IdstringThe 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.

Example response

201 · WebhookSecretIssued
{
  "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#

POST/partner/v1/webhooks/{id}/test

One attempt, logged like any delivery, never retried.

Authentication
Partner key in the Authorization header
Scopes required
Any valid key
curl -sS -X POST "$LP_BASE_URL/partner/v1/webhooks/7f3a2c10-5b8e-4d21-9c47-1a2b3c4d5e01/test" \
  -H "Authorization: Bearer $LP_API_KEY"

Parameters

NameInTypeDescription
id *pathstring

Responses

201SentWebhookDelivery

Headers

NameTypeDescription
X-Request-IdstringThe 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-LimitintegerThe key's requests per minute.
RateLimit-RemainingintegerRequests left in the current minute.
RateLimit-ResetintegerSeconds until the minute window resets.

Schema

  • idstringrequired

    length 1 – 64

  • subscriptionIdstringrequired

    length 1 – 64

  • eventIdstringrequirednullable
  • eventTypeWebhookEventTyperequired

    Values: "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"

  • subjectstringrequirednullable
  • branchIdstringrequirednullable
  • attemptintegerrequired

    value ≥ 0

  • statusWebhookDeliveryStatusrequired

    Values: "pending""delivered""failed""dead"

  • httpStatusintegerrequirednullable
  • durationMsintegerrequirednullable
  • errorstringrequirednullable
  • nextAtstring<date-time>requirednullable
  • createdAtstring<date-time>required
  • lastAttemptAtstring<date-time>requirednullable
  • deliveredAtstring<date-time>requirednullable
  • replayOfstringrequirednullable
401UNAUTHENTICATED (no key, a wrong or revoked one), KEY_EXPIRED, KEY_ENVIRONMENT_MISMATCH (a test key on production or the other way round)PartnerError

Headers

NameTypeDescription
X-Request-IdstringThe 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

Headers

NameTypeDescription
X-Request-IdstringThe 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

Headers

NameTypeDescription
X-Request-IdstringThe 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

Headers

NameTypeDescription
X-Request-IdstringThe 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

Headers

NameTypeDescription
X-Request-IdstringThe 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.

Example response

201 · WebhookDelivery
{
  "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#

GET/partner/v1/webhooks/{id}/deliveries
Authentication
Partner key in the Authorization header
Scopes required
Any valid key
curl -sS "$LP_BASE_URL/partner/v1/webhooks/7f3a2c10-5b8e-4d21-9c47-1a2b3c4d5e01/deliveries" \
  -H "Authorization: Bearer $LP_API_KEY"

Parameters

NameInTypeDescription
id *pathstring
statusquerystringComma-separated: pending, delivered, failed, dead.
beforequerystring
limitqueryinteger

Responses

200OKWebhookDeliveryPage

Headers

NameTypeDescription
X-Request-IdstringThe 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-LimitintegerThe key's requests per minute.
RateLimit-RemainingintegerRequests left in the current minute.
RateLimit-ResetintegerSeconds until the minute window resets.

Schema

  • deliveriesWebhookDelivery[]required
    Child attributes (16)
    • idstringrequired

      length 1 – 64

    • subscriptionIdstringrequired

      length 1 – 64

    • eventIdstringrequirednullable
    • eventTypeWebhookEventTyperequired

      Values: "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"

    • subjectstringrequirednullable
    • branchIdstringrequirednullable
    • attemptintegerrequired

      value ≥ 0

    • statusWebhookDeliveryStatusrequired

      Values: "pending""delivered""failed""dead"

    • httpStatusintegerrequirednullable
    • durationMsintegerrequirednullable
    • errorstringrequirednullable
    • nextAtstring<date-time>requirednullable
    • createdAtstring<date-time>required
    • lastAttemptAtstring<date-time>requirednullable
    • deliveredAtstring<date-time>requirednullable
    • replayOfstringrequirednullable
  • nextBeforestringoptional
401UNAUTHENTICATED (no key, a wrong or revoked one), KEY_EXPIRED, KEY_ENVIRONMENT_MISMATCH (a test key on production or the other way round)PartnerError

Headers

NameTypeDescription
X-Request-IdstringThe 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

Headers

NameTypeDescription
X-Request-IdstringThe 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

Headers

NameTypeDescription
X-Request-IdstringThe 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

Headers

NameTypeDescription
X-Request-IdstringThe 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

Headers

NameTypeDescription
X-Request-IdstringThe 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.

Example response

200 · WebhookDeliveryPage
{
  "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#

POST/partner/v1/webhooks/{id}/deliveries/{deliveryId}/replay

A new delivery of the same envelope (same id: deduplicate on it), sent by the worker.

Authentication
Partner key in the Authorization header
Scopes required
Any valid key
curl -sS -X POST "$LP_BASE_URL/partner/v1/webhooks/7f3a2c10-5b8e-4d21-9c47-1a2b3c4d5e01/deliveries/string/replay" \
  -H "Authorization: Bearer $LP_API_KEY"

Parameters

NameInTypeDescription
id *pathstring
deliveryId *pathstring

Responses

201QueuedWebhookDelivery

Headers

NameTypeDescription
X-Request-IdstringThe 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-LimitintegerThe key's requests per minute.
RateLimit-RemainingintegerRequests left in the current minute.
RateLimit-ResetintegerSeconds until the minute window resets.

Schema

  • idstringrequired

    length 1 – 64

  • subscriptionIdstringrequired

    length 1 – 64

  • eventIdstringrequirednullable
  • eventTypeWebhookEventTyperequired

    Values: "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"

  • subjectstringrequirednullable
  • branchIdstringrequirednullable
  • attemptintegerrequired

    value ≥ 0

  • statusWebhookDeliveryStatusrequired

    Values: "pending""delivered""failed""dead"

  • httpStatusintegerrequirednullable
  • durationMsintegerrequirednullable
  • errorstringrequirednullable
  • nextAtstring<date-time>requirednullable
  • createdAtstring<date-time>required
  • lastAttemptAtstring<date-time>requirednullable
  • deliveredAtstring<date-time>requirednullable
  • replayOfstringrequirednullable
401UNAUTHENTICATED (no key, a wrong or revoked one), KEY_EXPIRED, KEY_ENVIRONMENT_MISMATCH (a test key on production or the other way round)PartnerError

Headers

NameTypeDescription
X-Request-IdstringThe 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

Headers

NameTypeDescription
X-Request-IdstringThe 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

Headers

NameTypeDescription
X-Request-IdstringThe 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

Headers

NameTypeDescription
X-Request-IdstringThe 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

Headers

NameTypeDescription
X-Request-IdstringThe 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.

Example response

201 · WebhookDelivery
{
  "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"
}