Update Webhook entity.

PUT/api/webhooks/{id}

Updates a Webhook entity. Omitted fields keep their value; the secret never changes. Set active to false to pause deliveries.

PUTRequest

import { RecranetApiClient } from "@recranet/sdk";

const client = new RecranetApiClient({ apiKey: process.env.RECRANET_API_KEY! });

const result = await client.webhooks.update({
  id: 0,
});

Responses

Response 200

Successful response

application/json

Example responseGenerated from schema

{
  "id": 0,
  "url": "url",
  "secret": "secret",
  "description": "description",
  "events": [],
  "active": true
}

Response 400

Bad request

application/json

Example 1

{
  "statusCode": 400,
  "description": "Bad request",
  "errors": [
    "Bad request"
  ]
}

Response 404

Not found

application/json

Example 1

{
  "statusCode": 404,
  "description": "Not found",
  "errors": [
    "Not found"
  ]
}

Path parameters

idnumberrequired

Request body

Required: Yes
Content type: application/json

descriptionstringoptional
urlstringoptional
eventsstring[]optional
activebooleanoptional

Returns

Schema shown for 200 · application/json

idnumber
descriptionstringoptional
urlstring
secretstring
eventsstring[]optional
activebooleanoptional
Default: true