Skip to main content
Node.js
import { PeriskopeApi } from '@periskope/periskope-client';

const client = new PeriskopeApi({
  authToken: 'YOUR_API_KEY',
  phone: 'YOUR_PHONE_NUMBER', // e.g., '919876543210'
});

async function createWebhook() {
  const response = await client.webhooks.create({
    hookUrl: 'https://example.com/webhook',
    integrationName: 'message.created'
  });

  console.log(response);
}

createWebhook();
{
  "id": "0ef25935-0b78-4660-beeb-f17311793305",
  "subscribed_at": "2025-11-16T11:20:42.038+00:00",
  "is_subscribed": true,
  "integration_name": "ticket.created",
  "integration_type": "webhook",
  "type": "webhook",
  "integration_metadata": {
    "id": "28ee5da7-d6e5-438b-8b73-9eba97f08269",
    "name": "https://webhook.site/951e142b-d2e6-420d-a666-f2c4bd8e572c"
  },
  "org_id": "03a52dbe-b8af-47c5-9fd1-e5a622680cad",
  "hook_url": "https://webhook.site/951e142b-d2e6-420d-a666-f2c4bd8e572c",
  "integration_id": "28ee5da7-d6e5-438b-8b73-9eba97f08269"
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json
​
hookUrl
string
required

The URL where webhook events will be sent. Must be a valid HTTP or HTTPS URL

Example:

"https://example.com/webhook"

​
integrationName
required

The integration name(s) to subscribe to. Can be a single string or an array of strings

Example:

"message.created"

​
integrationMetadata
object

Optional metadata object for the webhook

​
integrationType
string

The type of integration

Example:

"webhook"

​
type
string

The webhook type

Example:

"webhook"

​
name
string

Optional name for the webhook

Example:

"My Webhook"

Response

201 - application/json

201 Created

​
id
string

Unique identifier of the webhook subscription

Example:

"0ef25935-0b78-4660-beeb-f17311793305"

​
subscribed_at
string

Timestamp when the webhook was subscribed

Example:

"2025-11-16T11:20:42.038+00:00"

​
is_subscribed
boolean

Whether the webhook is currently active

Example:

true

​
integration_name
string

Name of the event this webhook listens to

Example:

"ticket.created"

​
integration_type
string

Type of integration

Example:

"webhook"

​
type
string

Type of the subscription

Example:

"webhook"

​
integration_metadata
object

Additional metadata about the integration

​
org_id
string

Organization ID that owns this webhook

Example:

"03a52dbe-b8af-47c5-9fd1-e5a622680cad"

​
hook_url
string

The URL where webhook events are sent

Example:

"https://webhook.site/951e142b-d2e6-420d-a666-f2c4bd8e572c"

​
integration_id
string

Unique identifier of the integration

Example:

"28ee5da7-d6e5-438b-8b73-9eba97f08269"