POST
/
webhooks
import { Panora } from "@panora/sdk";

const panora = new Panora({
  apiKey: "<YOUR_API_KEY_HERE>",
});

async function run() {
  const result = await panora.webhooks.create({
    url: "https://acme.com/webhook_receiver",
    description: "Webhook to receive connection events",
    scope: [
      "connection.created",
    ],
  });
  
  // Handle the result
  console.log(result)
}

run();
{
  "id_webhook_endpoint": "801f9ede-c698-4e66-a7fc-48d19eebaa4f",
  "endpoint_description": "Webhook to receive connection events",
  "url": "https://acme.com/webhook_receiver",
  "secret": "801f9ede-c698-4e66-a7fc-48d19eebaa4f",
  "active": true,
  "created_at": "2024-10-01T12:00:00Z",
  "scope": [
    "connection.created"
  ],
  "id_project": "801f9ede-c698-4e66-a7fc-48d19eebaa4f",
  "last_update": "2024-10-01T12:00:00Z"
}

Authorizations

​
x-api-key
string
header
required

Body

application/json
​
url
string | null
required

The endpoint url of the webhook.

Example:

"https://acme.com/webhook_receiver"

​
scope
string[] | null
required

The events that the webhook listen to.

Example:
["connection.created"]
​
description
string | null

The description of the webhook.

Example:

"Webhook to receive connection events"

Response

201 - application/json
​
id_webhook_endpoint
string | null
required

The unique UUID of the webhook.

Example:

"801f9ede-c698-4e66-a7fc-48d19eebaa4f"

​
endpoint_description
string | null
required

The description of the webhook.

Example:

"Webhook to receive connection events"

​
url
string | null
required

The endpoint url of the webhook.

Example:

"https://acme.com/webhook_receiver"

​
secret
string
required

The secret of the webhook.

Example:

"801f9ede-c698-4e66-a7fc-48d19eebaa4f"

​
active
boolean | null
required

The status of the webhook.

Example:

true

​
created_at
string | null
required

The created date of the webhook.

Example:

"2024-10-01T12:00:00Z"

​
scope
string[] | null
required

The events that the webhook listen to.

Example:
["connection.created"]
​
id_project
string | null
required

The project id tied to the webhook.

Example:

"801f9ede-c698-4e66-a7fc-48d19eebaa4f"

​
last_update
string | null
required

The last update date of the webhook.

Example:

"2024-10-01T12:00:00Z"

Was this page helpful?

Suggest editsRaise issue