Upsert webhook config

Create or update the partner webhook URL and secret for the API key's environment. Fan-in deliveries for all sub-merchants. See the [Partner webhooks](/docs/partners/webhooks) guide.

Create or update the partner webhook URL and secret for the API key's environment. Fan-in deliveries for all sub-merchants. See the Partner webhooks guide.

Authorization

bearerAuth

AuthorizationBearer <token>

Partner API key (pt_test_... or pt_live_...)

In: header

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Do not send environment — it comes from the Partner API key.

url*string

Formaturi

secret?string

Required on first create; omit later to keep the existing secret

Length16 <= length <= 255

enabled?boolean

customHeaders?

Cannot override Content-Type or X-Coinpay-Signature

Response Body

`application/json`

curl -X PUT "https://example.com/v1/partner/webhook" \  -H "Content-Type: application/json" \  -d '{    "url": "http://example.com"  }'

{  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",  "environment": "test",  "url": "http://example.com",  "customHeaders": {    "property1": "string",    "property2": "string"  },  "enabled": true,  "secretConfigured": true,  "createdAt": "2019-08-24T14:15:22Z",  "updatedAt": "2019-08-24T14:15:22Z"}

{  "error": {    "code": "string",    "message": "string"  }}

Upsert webhook config

Authorization

Request Body

Response Body

200application/json

400application/json

`application/json`

`application/json`