Skip to content

Change the URL or pause an endpoint

PATCH
/reports/webhooks/{endpoint_id}

Changes the URL, the active flag, or both. A paused endpoint keeps its secret and receives nothing until it is switched back on.

Authorizations

ApiKeyAuth

API key from the dashboard. Some Host Mode endpoints also accept the key as an api_key field in the request body — this is stated in the schema of the particular operation.

Type
API Key (header: X-API-KEY)

Parameters

Header Parameters

X-Real-IP*

An IP address from the key's whitelist. A request from an address outside the whitelist is rejected with 401.

Type
string
Required
Example"203.0.113.10"
Format
"ipv4"

Path Parameters

endpoint_id*
Type
integer
Required

Request Body

application/json
JSON
{
  
"url": "string",
  
"is_active": true
}

Responses

Updated.

application/json
JSON
{
  
"status": "success",
  
"code": 0,
  
"msg": "",
  
"data": {
  
  
"id": 0,
  
  
"url": "string",
  
  
"role": "string",
  
  
"is_active": true,
  
  
"created_at": "string",
  
  
"updated_at": "string"
  
}
}

Playground

Authorization
Headers
Variables
Key
Value
Body

Samples

Powered by VitePress OpenAPI