Skip to main content
PATCH
/
v1
/
webhooks
/
{webhookId}
Update a webhook
curl --request PATCH \
  --url https://cds.marmar.life/v1/webhooks/{webhookId} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "<string>",
  "url": "<string>",
  "events": [
    "<string>"
  ],
  "status": "active"
}
'
{
  "webhook": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "name": "<string>",
    "url": "<string>",
    "events": [
      "assessment.completed"
    ],
    "status": "active",
    "createdAt": "2023-11-07T05:31:56Z",
    "updatedAt": "2023-11-07T05:31:56Z"
  }
}

Authorizations

Authorization
string
header
required

API key obtained from the Tenant Dashboard. Use as Authorization: Bearer YOUR_API_KEY

Path Parameters

webhookId
string<uuid>
required

Body

application/json
name
string
Required string length: 1 - 128
url
string<uri>
events
string[]
status
enum<string>
Available options:
active,
paused,
disabled

Response

Webhook updated

webhook
object