Change webhook subscriptions or active state (owner only)

PATCH

/dashboard/v1/merchants/{merchantId}/{mode}/webhook-endpoints/{id}

curl --request PATCH \
  --url http://localhost:4000/dashboard/v1/merchants/example/test/webhook-endpoints/example \
  --header 'Content-Type: application/json' \
  --header 'idempotency-key: example' \
  --cookie better-auth.session_token=<better-auth.session_token> \
  --data '{ "event_types": [ "payment.succeeded" ], "active": true }'

Authorizations

• dashboardSession

Parameters

Path Parameters

merchantId

required

string

mode

required

string

Allowed values: test live

id

required

string

Header Parameters

idempotency-key

required

Required retry-safe key; reuse it only for the same operation and request body

string

>= 1 characters <= 255 characters

Required retry-safe key; reuse it only for the same operation and request body

Request Body^required

Media typeapplication/json

object

event_types

Array<string>

>= 1 items <= 13 items

Allowed values: payment.succeeded payment.failed payment.expired payment.refunded payout.succeeded payout.failed invoice.created invoice.paid invoice.overdue subscription.past_due subscription.canceled subscription.completed exchange.needs_review

active

boolean

Responses

200

Updated destination

Media typeapplication/json

object

object

required

string

Allowed values: webhook_endpoint

id

required

string

merchant_id

required

string

mode

required

string | null

Allowed values: test live

is_default

required

boolean

managed_by

required

string | null

Allowed values: whatsapp

url

required

string | null

event_types

required

Array<string>

Allowed values: payment.succeeded payment.failed payment.expired payment.refunded payout.succeeded payout.failed invoice.created invoice.paid invoice.overdue subscription.past_due subscription.canceled subscription.completed exchange.needs_review

payload_policy

required

string

Allowed values: full minimal

active

required

boolean

created_at

required

string

Example

{
  "object": "webhook_endpoint",
  "mode": "test",
  "managed_by": "whatsapp",
  "event_types": [
    "payment.succeeded"
  ],
  "payload_policy": "full"
}

400

Invalid request

Media typeapplication/json

object

error

required

object

code

required

string

message

required

string

details

Example^generated

{
  "error": {
    "code": "example",
    "message": "example",
    "details": "example"
  }
}

401

Sign-in required

Media typeapplication/json

object

error

required

object

code

required

string

message

required

string

details

Example^generated

{
  "error": {
    "code": "example",
    "message": "example",
    "details": "example"
  }
}

403

Forbidden

Media typeapplication/json

object

error

required

object

code

required

string

message

required

string

details

Example^generated

{
  "error": {
    "code": "example",
    "message": "example",
    "details": "example"
  }
}

404

Not found

Media typeapplication/json

object

error

required

object

code

required

string

message

required

string

details

Example^generated

{
  "error": {
    "code": "example",
    "message": "example",
    "details": "example"
  }
}

409

Idempotency conflict or invalid state

Media typeapplication/json

object

error

required

object

code

required

string

message

required

string

details

Example^generated

{
  "error": {
    "code": "example",
    "message": "example",
    "details": "example"
  }
}