Skip to main content
PATCH
/
api
/
v1
/
mgt
/
workspaces
/
{workspaceId}
/
webhook-subscriptions
/
{subscriptionId}
Update Webhook Subscription
curl --request PATCH \
  --url https://api.xenia.team/api/v1/mgt/workspaces/{workspaceId}/webhook-subscriptions/{subscriptionId} \
  --header 'Content-Type: application/json' \
  --header 'x-client-key: <api-key>' \
  --header 'x-client-secret: <api-key>' \
  --data '
{
  "events": [
    "task.status_changed",
    "submission.submitted",
    "user.activated"
  ],
  "isActive": true
}
'
{
  "status": true,
  "code": 123,
  "data": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "name": "<string>",
    "url": "<string>",
    "events": [
      "<string>"
    ],
    "isActive": true,
    "updatedAt": "2023-11-07T05:31:56Z"
  }
}

Authorizations

x-client-key
string
header
required
x-client-secret
string
header
required

Path Parameters

workspaceId
string<uuid>
required

Workspace ID

subscriptionId
string<uuid>
required

Subscription ID

Body

application/json
name
string
Maximum string length: 255
url
string<uri>
Maximum string length: 2048
events
string[]
Required array length: 1 - 50 elements
description
string
Maximum string length: 2000
rateLimit
integer
Required range: 1 <= x <= 1000
metadata
object
isActive
boolean

Set to false to pause the subscription

Response

Subscription updated successfully

status
boolean
code
integer
data
object