Webhook

Create a new webhook

Creates a new webhook record.

post/v1/webhook

Request

  • Base URL: https://api.finalpos.com (the document declares no server; this is the origin it was published from)
  • URL: https://api.finalpos.com/v1/webhook
  • Auth: API key in header x-api-key

Request body

namestring required

Name of the webhook.

descriptionstring

Description of the webhook.

enabledboolean required

Whether the webhook is enabled.

urlstring required

URL of the webhook.

eventsstring[]

Events of the webhook.

Example request

{
  "name": "Super Webhook",
  "description": "This is a webhook for the Super Webhook",
  "enabled": true,
  "url": "https://webhook.site/1234567890",
  "events": [
    "orders.insert",
    "products.insert"
  ]
}

Response

The webhook has been successfully created.

idstring

Unique identifier for the Webhook.

createdAtstring date-time

Timestamp when the Webhook was created.

updatedAtstring date-time

Timestamp when the Webhook was last updated.

namestring

Name of the webhook.

descriptionstring

Description of the webhook.

companyIdstring

Company ID associated with the Webhook.

organizationIdstring

Organization ID associated with the Webhook.

enabledboolean

Whether the webhook is enabled.

urlstring

URL of the webhook.

secretstring

Secret for signing the webhook payload. Generated by the system & shared with the client once on creation.

eventsstring[]

Events of the webhook.

Example response

{
  "id": "o1p2q3r4s5t6u7v8w9x0y1z2",
  "createdAt": "2025-12-07T19:31:48.436+00:00",
  "updatedAt": "2025-12-07T19:35:48.436+00:00",
  "name": "Super Webhook",
  "description": "This is a webhook for the Super Webhook",
  "companyId": "o1p2q3r4s5t6u7v8w9x0y1z2",
  "organizationId": "o1p2q3r4s5t6u7v8w9x0y1z2",
  "enabled": true,
  "url": "https://webhook.site/1234567890",
  "secret": "1234567890",
  "events": [
    "orders.insert",
    "products.insert"
  ]
}

Changes

No recorded changes to this operation across all 1 revision of this API.