List webhook destinations (owner only)

GET

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

curl --request GET \
  --url http://localhost:4000/dashboard/v1/merchants/example/test/webhook-endpoints \
  --cookie better-auth.session_token=<better-auth.session_token>

Authorizations

• dashboardSession

Parameters

Path Parameters

merchantId

required

string

mode

required

string

Allowed values: test live

Responses

200

Destinations without secrets

Media typeapplication/json

object

object

required

string

Allowed values: list

data

required

Array<object>

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

has_more

required

boolean

Example

{
  "object": "list",
  "data": [
    {
      "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"
  }
}