Webhooks
Create Webhook
POST
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.
application/json- body
name*stringLength
1 <= length <= 120url*stringFormat
uriLength
length <= 2048secret?stringLength
16 <= length <= 128events*array<string>Items
1 <= items <= 31enabled?booleanDefault
trueCreated webhook. The signing secret is shown only in this response.
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.createWebhook({ createWebhookBody: { "name": "Post events", "url": "https://example.com/hooks/onepostly", "secret": "s7a9Kx2mQ8vB4nR6tY3wZ1pL5oN0uMf", "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" ], "secret": "s7a9Kx2mQ8vB4nR6tY3wZ1pL5oN0uMf" }}