Update existing webhook subscription

Production Environment

PUT

/api/1/partner/webhooks/{id}

Webhook subscriptions

Request

Authorization

Add parameter in header

x-api-key

Example:

x-api-key: ********************

Path Params

string <uuid>

required

Webhook subscription id

Example:

ep_1srOrx2ZWZBpBUvZwXKQmoEYgab

Body Params application/json

events

array[string]

required

Allowed values:

merchant.capabilities.updatedmerchant.payout.createdmerchant.payout.paidmerchant.payout.cancelledmerchant.payout.failedpayment.successpayment.failedpaymentLink.createdpaymentLink.updatedpaymentLink.revoked

url

string <uri>

required

merchantIds

array[string <uuid>] | null

optional

<= 1 items

Example

{
  "events": [
    "payment.success"
  ],
  "url": "https://api.example/webhooks/lopay"
}

Request samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --request PUT 'https://api.lopay.com/api/1/partner/webhooks/' \
--header 'Content-Type: application/json' \
--data-raw '{
    "events": [
        "payment.success"
    ],
    "url": "https://api.example/webhooks/lopay"
}'

Responses

🟢200OK

application/json

OK response

Body

string

required

events

array[string]

required

Allowed values:

url

string <uri>

required

Example

{
  "id": "ep_1srOrx2ZWZBpBUvZwXKQmoEYgab",
  "events": [
    "payment.success",
    "payment.failed"
  ],
  "url": "https://api.example/webhooks/lopay"
}

🟠400Bad Request

🟠401Unauthorized

Modified at 2025-03-03 16:34:00

Create webhook subscription

Remove an existing webhook subscription