Create webhooks

POST/v1/webhooks

Body parameters

application/json · array of records · required

name string required

Display name of the resource.

Minimum length: 1 character. · Maximum length: 120 characters.

ExampleNQD record

destination string required

destination for this webhook.

Minimum length: 1 character. · Maximum length: 2048 characters.

Examplehttps://example.com/hooks/nqd

events string[] required

Event names delivered by the webhook.

at least 1 items · at most 150 items

Example1 item

Headers

authorization string required

Bearer workspace API key.

ExampleBearer $NQD_API_KEY

workspace-id string required

Workspace scope for the request. Required for workspace operations and must belong to the authenticated identity.

Minimum length: 1 character. · Maximum length: 128 characters.

Example01JQ2T5Y5Q3R8W9N6M4K2H7P1A

Inspect webhook state and delivery attempts through the related resources.

Response

201Success

Response headers

x-request-id string

Correlation identifier returned with every response for support and request tracing.

Example550e8400-e29b-41d4-a716-446655440000

data object[]

Returned records. Collections and batches use an array; single records use an object.

ShowHide 2 properties

data[].webhook object

webhook for this webhook.

ShowHide 8 properties

data[].webhook.id string

Opaque identifier for this resource or reference.

Minimum length: 1 character. · Maximum length: 128 characters.

Example01JQ2T5Y5Q3R8W9N6M4K2H7P1Y

data[].webhook.name string

Display name of the record.

Minimum length: 1 character. · Maximum length: 120 characters.

ExampleNQD record

data[].webhook.destination string

destination within webhook.

Examplehttps://example.com/hooks/nqd

data[].webhook.events string[]

Event names delivered by the webhook.

at least 1 items · at most 150 items

Example1 item

data[].webhook.status string

Current status of the record or operation.

Allowed values: "pending_verification", "active", "paused", "deleted"

Examplepending_verification

data[].webhook.verifiedAt string

ISO 8601 timestamp for verified.

Example2026-01-15T12:00:00.000Z

data[].webhook.createdAt string

ISO 8601 timestamp for the authored or payment event. Recurring records preserve their scheduled occurrence.

Example2026-01-15T12:00:00.000Z

data[].webhook.updatedAt string

Timestamp used for stale-edit protection. Preserve the server value when updating.

Example2026-01-15T12:00:00.000Z

data[].signingSecret string

signing secret for this webhook.

Examplewhsec_01JQ2T5Y5Q3R8W9N6M4K2H7P1A

Possible errors

400 Invalid request

Response headers

x-request-id string

Correlation identifier returned with every response for support and request tracing.

Example550e8400-e29b-41d4-a716-446655440000

error object

Error details returned for a failed request.

ShowHide 4 properties

error.code string

Stable machine-readable error or resource code.

Exampleinvalid_input

error.message string

Human-readable explanation of the result or error.

ExampleThe request could not be validated.

error.requestId string

Correlation identifier for support and request tracing.

Example550e8400-e29b-41d4-a716-446655440000

error.details object nullable

Additional structured details about the result or error.

ShowHide 1 property

error.details.issues object[]

Structured field issues returned when request validation fails.

ShowHide 3 properties

error.details.issues[].path string | number[]

Field path where the validation issue occurred.

One of: string alternative 1, number alternative 2

Example0 items

error.details.issues[].reason string

Machine-readable reason for the validation issue.

Allowed values: "expected_type", "required", "unexpected_property", "invalid_value", "invalid_json", "invalid_query", "unsupported_media_type", "body_too_large", "body_timeout", "conflicting_scope", "missing_header", "concurrency_required", "invalid_resource_id", "invalid_request"

Exampleinvalid_request

error.details.issues[].code string nullable

Stable machine-readable error or resource code.

Exampleinvalid_input

{
  "error": {
    "code": "invalid_input",
    "message": "The request could not be validated.",
    "requestId": "550e8400-e29b-41d4-a716-446655440000",
    "details": {
      "issues": [
        {
          "path": [],
          "reason": "invalid_request"
        }
      ]
    }
  }
}

View raw OpenAPI operation

Use the machine-readable contract for client generation and payload validation.

Open OpenAPI contract ↗