List webhook endpoints

GET

/v1/webhooks

const url = 'https://api.octaneai.com/v1/webhooks?limit=20';
const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request GET \
  --url 'https://api.octaneai.com/v1/webhooks?limit=20' \
  --header 'Authorization: Bearer <token>'

Authorizations

ApiKey

Parameters

Query Parameters

cursor

Any of:

string
null

string

<= 200 characters

From the previous page’s nextCursor

limit

Limit

integer

default: 20 >= 1 <= 100

Responses

200

One page of the store’s endpoints; status reads paused_plan while the plan has no API.

application/json

WebhookList

object

data

required

Data

Array<object>

WebhookSummary

object

consecutive_failures

required

Consecutive Failures

integer

created_at

required

Created At

string format: date-time

description

required

Any of:

string
null

string

disabled_at

required

Any of:

string
null

string format: date-time

disabled_reason

required

Any of:

string
null

string

failing_since

required

Any of:

string
null

string format: date-time

required

string

/^whe_[0-9a-f]{32}$/

include_pii

required

Include Pii

boolean

last_delivered_at

required

Any of:

string
null

string format: date-time

status

required

Status

string

Allowed values: pending active disabled paused_plan

topics

required

Topics

Array<string>

Allowed values: quiz.started quiz.finished quiz.abandoned identity.captured quiz.published profile.created profile.updated export.completed webhook.endpoint.disabled

updated_at

required

Updated At

string format: date-time

url

required

Url

string

verified_at

required

Any of:

string
null

string format: date-time

has_more

required

Has More

boolean

next_cursor

required

Any of:

string
null

string

Example

{
  "data": [
    {
      "consecutive_failures": 0,
      "created_at": "2026-09-01T12:00:00Z",
      "description": "Order desk",
      "id": "whe_3f2504e04f8911d39a0c0305e82c3301",
      "include_pii": false,
      "last_delivered_at": "2026-09-07T09:12:00Z",
      "status": "active",
      "topics": [
        "quiz.finished",
        "profile.created"
      ],
      "updated_at": "2026-09-01T12:00:05Z",
      "url": "https://hooks.example.com/octane",
      "verified_at": "2026-09-01T12:00:05Z"
    }
  ],
  "has_more": false
}

401

The key is missing, malformed, revoked or expired.

application/problem+json

Problem

The body of every non-2xx response.

object

detail

required

Detail

What went wrong, for people

string

errors

Any of:

Array<object>
null

Array<object>

FieldError

object

field

required

Field

The input that failed, as a dotted path (body.label, query.from)

string

message

required

Message

Why it failed

string

export

Any of:

object
null

object

key

additional properties

any

request_id

required

Request Id

The same value as the Request-Id header; quote it to support

string

required

Any of:

Array<string>
null

Array<string>

retry_after

Any of:

integer
null

integer

status

required

Status

The HTTP status of the response

integer

title

required

Title

The machine-readable error code

string

type

required

Type

A stable URI naming the error, on this API’s public host

string

Example

{
  "detail": "The API key is missing, malformed, revoked or expired",
  "request_id": "7c9e6679-7425-40de-944b-e07fc1f90ae7",
  "status": 401,
  "title": "invalid_api_key",
  "type": "https://api.octaneai.com/errors/invalid_api_key"
}

Headers

WWW-Authenticate

string

Example

Bearer

403

The store’s plan has no API access, or the key lacks the scope.

application/problem+json

Problem

The body of every non-2xx response.

object

detail

required

Detail

What went wrong, for people

string

errors

Any of:

Array<object>
null

Array<object>

FieldError

object

field

required

Field

The input that failed, as a dotted path (body.label, query.from)

string

message

required

Message

Why it failed

string

export

Any of:

object
null

object

key

additional properties

any

request_id

required

Request Id

The same value as the Request-Id header; quote it to support

string

required

Any of:

Array<string>
null

Array<string>

retry_after

Any of:

integer
null

integer

status

required

Status

The HTTP status of the response

integer

title

required

Title

The machine-readable error code

string

type

required

Type

A stable URI naming the error, on this API’s public host

string

Examples

{
  "detail": "The API key does not carry the scope this route needs",
  "request_id": "7c9e6679-7425-40de-944b-e07fc1f90ae7",
  "required": [
    "quizzes:read"
  ],
  "status": 403,
  "title": "insufficient_scope",
  "type": "https://api.octaneai.com/errors/insufficient_scope"
}

{
  "detail": "The merchant API is available on the Plus and Enterprise plans",
  "request_id": "7c9e6679-7425-40de-944b-e07fc1f90ae7",
  "status": 403,
  "title": "plan_required",
  "type": "https://api.octaneai.com/errors/plan_required"
}

422

A request parameter is invalid.

application/problem+json

Problem

The body of every non-2xx response.

object

detail

required

Detail

What went wrong, for people

string

errors

Any of:

Array<object>
null

Array<object>

FieldError

object

field

required

Field

The input that failed, as a dotted path (body.label, query.from)

string

message

required

Message

Why it failed

string

export

Any of:

object
null

object

key

additional properties

any

request_id

required

Request Id

The same value as the Request-Id header; quote it to support

string

required

Any of:

Array<string>
null

Array<string>

retry_after

Any of:

integer
null

integer

status

required

Status

The HTTP status of the response

integer

title

required

Title

The machine-readable error code

string

type

required

Type

A stable URI naming the error, on this API’s public host

string

Example

{
  "detail": "A request parameter is invalid.",
  "request_id": "7c9e6679-7425-40de-944b-e07fc1f90ae7",
  "status": 422,
  "title": "validation_error",
  "type": "https://api.octaneai.com/errors/validation_error"
}

429

The key’s or the store’s bucket is full; Retry-After says when to try again.

application/problem+json

Problem

The body of every non-2xx response.

object

detail

required

Detail

What went wrong, for people

string

errors

Any of:

Array<object>
null

Array<object>

FieldError

object

field

required

Field

The input that failed, as a dotted path (body.label, query.from)

string

message

required

Message

Why it failed

string

export

Any of:

object
null

object

key

additional properties

any

request_id

required

Request Id

The same value as the Request-Id header; quote it to support

string

required

Any of:

Array<string>
null

Array<string>

retry_after

Any of:

integer
null

integer

status

required

Status

The HTTP status of the response

integer

title

required

Title

The machine-readable error code

string

type

required

Type

A stable URI naming the error, on this API’s public host

string

Example

{
  "detail": "Too many requests",
  "request_id": "7c9e6679-7425-40de-944b-e07fc1f90ae7",
  "retry_after": 1,
  "status": 429,
  "title": "rate_limited",
  "type": "https://api.octaneai.com/errors/rate_limited"
}

504

The request timed out.

application/problem+json

Problem

The body of every non-2xx response.

object

detail

required

Detail

What went wrong, for people

string

errors

Any of:

Array<object>
null

Array<object>

FieldError

object

field

required

Field

The input that failed, as a dotted path (body.label, query.from)

string

message

required

Message

Why it failed

string

export

Any of:

object
null

object

key

additional properties

any

request_id

required

Request Id

The same value as the Request-Id header; quote it to support

string

required

Any of:

Array<string>
null

Array<string>

retry_after

Any of:

integer
null

integer

status

required

Status

The HTTP status of the response

integer

title

required

Title

The machine-readable error code

string

type

required

Type

A stable URI naming the error, on this API’s public host

string

Example

{
  "detail": "The request timed out.",
  "request_id": "7c9e6679-7425-40de-944b-e07fc1f90ae7",
  "status": 504,
  "title": "timeout",
  "type": "https://api.octaneai.com/errors/timeout"
}