Admin APIWebhooks

Create webhook

POST{handle}.blutui.com/admin/api/webhooks

Create a webhook endpoint in a project.

Body parameters

urlstringrequired

The webhook endpoint to receive events.

eventsarrayrequired

The list of events to send to the webhook endpoint.

events.*string

The webhook event.

Response

import Blutui from 'blutui'

const blutui = new Blutui('ey....')

blutui.project('one').admin.webhooks.create({
  url: 'https://webhook.endpoint.test/123456',
  events: ['form.submission.created'],
})
JSON Response
{
  "id": "9a228a02-305b-4bfc-8e69-e523a95c216c",
  "object": "webhook",
  "url": "https://webhook.endpoint.test/123456",
  "events": ["form.submission.created"],
  "disabled": false,
  "created_at": "2024-08-14T16:49:46+12:00",
  "updated_at": "2024-08-14T16:49:46+12:00"
}
idstring

The unique identifier for this webhook endpoint.

objectstring

This will always contain webhook for this endpoint.

urlstring

The webhook endpoint to receive events.

eventsarray

The list of events to send to the webhook endpoint.

events.*string

The webhook event.

disabledboolean

Whether the webhook endpoint is disabled or not.

created_atstring

The date and time when the webhook endpoint was created.

updated_atstring

The date and time when the webhook endpoint was updated.

Last updated on