Webhooks
Update Webhook
PATCH
header
x-api-key<token>Workspace API key, sent in the x-api-key header. Keys start with op_ and are created in the dashboard.
id*stringLength
1 <= lengthapplication/json- body
name?stringLength
1 <= length <= 120url?stringFormat
uriLength
length <= 2048events?array<string>Items
1 <= items <= 31enabled?booleanUpdated
application/json- response
webhook*Example Request
import { Configuration, WebhooksApi } from "@onepostly/sdk";const webhooksApi = new WebhooksApi( new Configuration({ apiKey: process.env.ONEPOSTLY_API_KEY }));const response = await webhooksApi.updateWebhook({ id: "dlv_1", updateWebhookBody: { "name": "Post events", "url": "https://example.com/hooks/onepostly", "events": [ "post.platform.published" ], "enabled": true },});console.log(response);Example Response
{ "webhook": { "id": "dlv_1", "name": "Post events", "url": "https://example.com/hooks/onepostly", "enabled": true, "events": [ "post.platform.published" ] }}