Yapper Docs
Api reference
PATCH
/webhooks/{webhookId}

enabled: false stops deliveries and gives up on pending ones; enabled: true turns a disabled endpoint back on and clears its disabledReason. Catch up on what it missed with GET /events.

Authorization

bearerAuth webhooks:write
AuthorizationBearer <token>

In: header

Scope: webhooks:write

Path Parameters

webhookId*string
Match^whe_[A-Za-z0-9_-]{16}$

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

curl -X PATCH "https://example.com/webhooks/string" \  -H "Content-Type: application/json" \  -d '{}'
{  "data": {    "id": "string",    "url": "http://example.com",    "description": "string",    "events": [      "process.completed"    ],    "enabled": true,    "disabledReason": "disabled_by_user",    "disabledAt": "2019-08-24T14:15:22Z",    "failingSince": "2019-08-24T14:15:22Z",    "lastSuccessAt": "2019-08-24T14:15:22Z",    "createdBy": "string",    "createdAt": "2019-08-24T14:15:22Z",    "updatedAt": "2019-08-24T14:15:22Z",    "links": {      "self": "string",      "deliveries": "string"    }  }}
{  "error": {    "code": "string",    "message": "string",    "requestId": "string"  }}
{  "error": {    "code": "string",    "message": "string",    "requestId": "string"  }}
{  "error": {    "code": "string",    "message": "string",    "requestId": "string"  }}
{  "error": {    "code": "string",    "message": "string",    "requestId": "string"  }}
{  "error": {    "code": "string",    "message": "string",    "requestId": "string"  }}