Update Webhook Endpoint

PreviousGet Webhook Endpoint NextDelete Webhook Endpoint

Path Parameters

endpointId*string

Query Parameters

projectId?string|null

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

description?string|null|null

events?array<string>|null

name?string|null

status?|null

url?string|null

Response Body

`application/json`

curl -X PATCH "https://example.com/api/v1/webhooks/endpoints/string" \  -H "Content-Type: application/json" \  -d '{}'

{  "consecutiveFailures": 0,  "createdAt": "string",  "description": "string",  "events": [    "person.created"  ],  "id": "string",  "lastSuccessAt": "string",  "name": "string",  "projectId": "string",  "status": "active",  "url": "string"}

{  "_tag": "Api/WebhookValidationError",  "message": "string"}

{  "_tag": "Api/AuthenticationError",  "cause": "string",  "message": "string"}

{  "_tag": "Api/ActionForbiddenError",  "message": "string"}

{  "_tag": "Api/WebhookEndpointNotFoundError",  "endpointId": "string"}

{  "_tag": "Api/WebhookServiceError",  "cause": "string"}

Update Webhook Endpoint

Update Webhook Endpoint

Path Parameters

Query Parameters

Request Body

Response Body

200application/json

400application/json

401application/json

403application/json

404application/json

500application/json

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`