Update Webhook Configuration

PUT

/api/ApiKeys/{id}/webhook

curl --request PUT \
  --url https://example.com/api/ApiKeys/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/webhook \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0", "merchantId": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0", "webhookUrl": "https://example.com", "webhookEvents": [ "example" ], "webhookEnabled": true }'

Sets the webhook URL, subscribed event types, and enabled flag for this API key.

Authorizations

• Bearer

Parameters

Path Parameters

id

required

string format: uuid

Request Body

object

id

required

string format: uuid

merchantId

required

string format: uuid

webhookUrl

string format: uri

nullable <= 2048 characters

webhookEvents

Array<string>

nullable

webhookEnabled

boolean

Example ^generated

{
  "id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
  "merchantId": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
  "webhookUrl": "https://example.com",
  "webhookEvents": [
    "example"
  ],
  "webhookEnabled": true
}

object

id

required

string format: uuid

merchantId

required

string format: uuid

webhookUrl

string format: uri

nullable <= 2048 characters

webhookEvents

Array<string>

nullable

webhookEnabled

boolean

Example ^generated

{
  "id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
  "merchantId": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
  "webhookUrl": "https://example.com",
  "webhookEvents": [
    "example"
  ],
  "webhookEnabled": true
}

object

id

required

string format: uuid

merchantId

required

string format: uuid

webhookUrl

string format: uri

nullable <= 2048 characters

webhookEvents

Array<string>

nullable

webhookEnabled

boolean

Example ^generated

{
  "id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
  "merchantId": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
  "webhookUrl": "https://example.com",
  "webhookEvents": [
    "example"
  ],
  "webhookEnabled": true
}

Responses

200

OK

Media type application/json

object

id

string format: uuid

name

string

nullable

keyPrefix

string

nullable

signingSecretPrefix

string

nullable

webhookUrl

string

nullable

webhookEvents

Array<string>

nullable

webhookEnabled

boolean

expiresAt

string format: date-time

nullable

lastUsedAt

string format: date-time

nullable

revokedAt

string format: date-time

nullable

createdAt

string format: date-time

Example ^generated

{
  "id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
  "name": "example",
  "keyPrefix": "example",
  "signingSecretPrefix": "example",
  "webhookUrl": "example",
  "webhookEvents": [
    "example"
  ],
  "webhookEnabled": true,
  "expiresAt": "2026-04-15T12:00:00Z",
  "lastUsedAt": "2026-04-15T12:00:00Z",
  "revokedAt": "2026-04-15T12:00:00Z",
  "createdAt": "2026-04-15T12:00:00Z"
}

400

Bad Request

Media type application/json

object

type

string

nullable

title

string

nullable

status

integer format: int32

nullable

detail

string

nullable

instance

string

nullable

key

additional properties

Example ^generated

{
  "type": "example",
  "title": "example",
  "status": 1,
  "detail": "example",
  "instance": "example"
}

404

Not Found

Media type application/json

object

type

string

nullable

title

string

nullable

status

integer format: int32

nullable

detail

string

nullable

instance

string

nullable

key

additional properties

Example ^generated

{
  "type": "example",
  "title": "example",
  "status": 1,
  "detail": "example",
  "instance": "example"
}