API

Create a webhook

Creates a webhook for a company. The webhook will be triggered when any of the defined events occur.

POST/v1/hq/webhooks
AuthorizationBearer <token>

The Noona HQ API uses Bearer token for authentication.

Endpoints that return generic information that does not contain sensitive data do not require authentication. Endpoints that require authentication are specifically marked in the documentation.

Authorization: Bearer your-token

In: header

Query Parameters

select?array<string>
expand?array<string>

Request Body

application/json

title?string
Example"Event created"
description?string
Example"This webhook is triggered when an event is created"
callback_url?string
Example"https://your.server/webhook_handler"
events?WebhookEvents
Example[ "event.created", "event.updated", "event.deleted" ]
headers?
enabled?boolean

Whether the webhook is enabled or not

Exampletrue
company?string|

Response Body

application/json

curl -X POST "https://api.noona.is/v1/hq/webhooks" \  -H "Content-Type: application/json" \  -d '{}'
{
  "id": "7awdXwZoedakjad37a",
  "title": "Event created",
  "description": "This webhook is triggered when an event is created",
  "callback_url": "https://your.server/webhook_handler",
  "events": [
    "event.created",
    "event.updated",
    "event.deleted"
  ],
  "headers": [
    {
      "key": "Authorization",
      "values": [
        "string"
      ]
    }
  ],
  "enabled": true,
  "company": "string",
  "app": "string",
  "created_at": "2019-08-24T14:15:22Z",
  "updated_at": "2019-08-24T14:15:22Z"
}