Create webhook

Create a new webhook configuration. Maximum 10 webhooks per user. `name`, `url` and `events` are required. `url` must be a valid URL and `events` must contain at least one event. Whitespace is trimmed from `url` before validation. Webhooks are automatically disabled after 10 consecutive delivery failures.

Authorization

AuthorizationBearer <token>

API key authentication - use your Zernio API key as a Bearer token

In: header

Request Body

namestring

Webhook name (1-50 characters)

Length1 <= length <= 50

urlstring

Webhook endpoint URL (must be a valid URL, whitespace trimmed)

Formaturi

secret?string

Secret key for HMAC-SHA256 signature verification

eventsarray<string>

Events to subscribe to (at least one required)

Items1 <= items

isActive?boolean

Enable or disable webhook delivery. Defaults to true when omitted.

Defaulttrue

customHeaders?

Custom headers to include in webhook requests

Response Body

application/json

import Zernio from '@zernio/node';const zernio = new Zernio({ apiKey: process.env.ZERNIO_API_KEY });const { data } = await zernio.webhooks.createWebhookSettings({  body: {    name: 'Example',    url: 'https://example.com',    events: [      'post.scheduled',    ],  },});console.log(data);

{
  "success": true,
  "webhook": {
    "_id": "string",
    "name": "string",
    "url": "http://example.com",
    "secret": "string",
    "events": [
      "post.scheduled"
    ],
    "isActive": true,
    "lastFiredAt": "2019-08-24T14:15:22Z",
    "failureCount": 0,
    "customHeaders": {
      "property1": "string",
      "property2": "string"
    }
  }
}

Empty

{
  "error": "Unauthorized"
}

Create webhook

Authorization

AuthorizationBearer <token>

API key authentication - use your Zernio API key as a Bearer token

In: header

Request Body

namestring

Webhook name (1-50 characters)

Length1 <= length <= 50

urlstring

Webhook endpoint URL (must be a valid URL, whitespace trimmed)

Formaturi

secret?string

Secret key for HMAC-SHA256 signature verification

eventsarray<string>

Events to subscribe to (at least one required)

Items1 <= items

isActive?boolean

Enable or disable webhook delivery. Defaults to true when omitted.

Defaulttrue

customHeaders?

Custom headers to include in webhook requests

Response Body

application/json

import Zernio from '@zernio/node';

const zernio = new Zernio({ apiKey: process.env.ZERNIO_API_KEY });

const { data } = await zernio.webhooks.createWebhookSettings({
  body: {
    name: 'Example',
    url: 'https://example.com',
    events: [
      'post.scheduled',
    ],
  },
});
console.log(data);

import Zernio from '@zernio/node';const zernio = new Zernio({ apiKey: process.env.ZERNIO_API_KEY });const { data } = await zernio.webhooks.createWebhookSettings({  body: {    name: 'Example',    url: 'https://example.com',    events: [      'post.scheduled',    ],  },});console.log(data);

{
  "success": true,
  "webhook": {
    "_id": "string",
    "name": "string",
    "url": "http://example.com",
    "secret": "string",
    "events": [
      "post.scheduled"
    ],
    "isActive": true,
    "lastFiredAt": "2019-08-24T14:15:22Z",
    "failureCount": 0,
    "customHeaders": {
      "property1": "string",
      "property2": "string"
    }
  }
}

Empty

{
  "error": "Unauthorized"
}

Create webhook

Authorization

Request Body

Response Body

200application/json

400

401application/json

Create webhook

Authorization

Request Body

Response Body

200application/json

400

401application/json

application/json

application/json

application/json

application/json