Webhooks

Endpoints to manage Okendo webhooks

Webhooks

List Webhook Subscriptions

get

Returns a list of Webhook Subscriptions

Authorizations

basic

AuthorizationstringRequired

Query parameters

limitinteger · int32Optional

A limit on the number of items returned. Between 1 and 100. Default 25.

Example: 25

lastEvaluatedstringOptional

The URL-encoded JSON object representing the cursor for the next page of results.

orderBystringOptional

The sort order of the webhook subscriptions. Format: 'asc|desc'. Default 'desc'

Example: desc

Responses

200

An object containing a list of Webhook Subscriptions and a relative link to the next page of results if available.

application/json

400

Invalid request parameters.

application/json

401

Authentication credentials are missing or incorrect.

403

The requested resource is forbidden.

application/json

get

/webhook_subscriptions

HTTPcURLJavaScriptPython

GET /enterprise/webhook_subscriptions HTTP/1.1
Host: api.okendo.io
Authorization: Basic username:password
Accept: */*

{
  "webhookSubscriptions": [
    {
      "subscriberId": "123e4567-e89b-12d3-a456-426614174000",
      "webhookSubscriptionId": "123e4567-e89b-12d3-a456-426614174000",
      "endpointUrl": "https://example.com",
      "version": "2025-02-01",
      "subscriptions": [
        {
          "resourceType": "review",
          "topic": "create"
        }
      ],
      "isEnabled": true,
      "dateCreated": "2025-12-19T14:37:18.901Z",
      "dateModified": "2025-12-19T14:37:18.901Z"
    }
  ],
  "nextUrl": "https://example.com"
}

Create a Webhook Subscription

post

Authorizations

basic

AuthorizationstringRequired

Body

application/json

endpointUrlstring · uriRequired

The URL that the webhook event will be sent to

isEnabledbooleanRequired

versionstring · enumRequired

Webhook event version

Possible values:

Responses

200

A new Webhook Subscription object which also contains the Webhook Secret

application/json

401

Authentication credentials are missing or incorrect.

403

The requested resource is forbidden.

application/json

404

The requested resource could not be found.

application/json

422

The request was well-formed but was unable to be followed due to semantic errors.

application/json

post

/webhook_subscriptions

HTTPcURLJavaScriptPython

POST /enterprise/webhook_subscriptions HTTP/1.1
Host: api.okendo.io
Authorization: Basic username:password
Content-Type: application/json
Accept: */*
Content-Length: 138

{
  "endpointUrl": "https://example.com",
  "isEnabled": true,
  "subscriptions": [
    {
      "resourceType": "review",
      "topic": "create"
    }
  ],
  "version": "2025-02-01"
}

{
  "subscriberId": "123e4567-e89b-12d3-a456-426614174000",
  "webhookSubscriptionId": "123e4567-e89b-12d3-a456-426614174000",
  "endpointUrl": "https://example.com",
  "version": "2025-02-01",
  "subscriptions": [
    {
      "resourceType": "review",
      "topic": "create"
    }
  ],
  "isEnabled": true,
  "dateCreated": "2025-12-19T14:37:18.901Z",
  "dateModified": "2025-12-19T14:37:18.901Z",
  "webhookSecret": "text"
}

Retrieve a Webhook Subscription

get

Authorizations

basic

AuthorizationstringRequired

Path parameters

webhookSubscriptionIdstring · uuidRequired

Responses

200

A Webhook Subscription Object

application/json

401

Authentication credentials are missing or incorrect.

403

The requested resource is forbidden.

application/json

404

The requested resource could not be found.

application/json

get

/webhook_subscriptions/{webhookSubscriptionId}

HTTPcURLJavaScriptPython

GET /enterprise/webhook_subscriptions/{webhookSubscriptionId} HTTP/1.1
Host: api.okendo.io
Authorization: Basic username:password
Accept: */*

{
  "webhookSubscription": {
    "subscriberId": "123e4567-e89b-12d3-a456-426614174000",
    "webhookSubscriptionId": "123e4567-e89b-12d3-a456-426614174000",
    "endpointUrl": "https://example.com",
    "version": "2025-02-01",
    "subscriptions": [
      {
        "resourceType": "review",
        "topic": "create"
      }
    ],
    "isEnabled": true,
    "dateCreated": "2025-12-19T14:37:18.901Z",
    "dateModified": "2025-12-19T14:37:18.901Z"
  }
}

Update a Webhook Subscription

put

Authorizations

basic

AuthorizationstringRequired

Path parameters

webhookSubscriptionIdstring · uuidRequired

Body

application/json

endpointUrlstring · uriOptional

The URL that the webhook event will be sent to

versionstring · enumOptional

Webhook event version

Possible values:

isEnabledbooleanOptional

Responses

200

An updated Webhook Subscription Object

application/json

401

Authentication credentials are missing or incorrect.

403

The requested resource is forbidden.

application/json

404

The requested resource could not be found.

application/json

422

The request was well-formed but was unable to be followed due to semantic errors.

application/json

put

/webhook_subscriptions/{webhookSubscriptionId}

HTTPcURLJavaScriptPython

PUT /enterprise/webhook_subscriptions/{webhookSubscriptionId} HTTP/1.1
Host: api.okendo.io
Authorization: Basic username:password
Content-Type: application/json
Accept: */*
Content-Length: 138

{
  "endpointUrl": "https://example.com",
  "subscriptions": [
    {
      "resourceType": "review",
      "topic": "create"
    }
  ],
  "version": "2025-02-01",
  "isEnabled": true
}

{
  "webhookSubscription": {
    "subscriberId": "123e4567-e89b-12d3-a456-426614174000",
    "webhookSubscriptionId": "123e4567-e89b-12d3-a456-426614174000",
    "endpointUrl": "https://example.com",
    "version": "2025-02-01",
    "subscriptions": [
      {
        "resourceType": "review",
        "topic": "create"
      }
    ],
    "isEnabled": true,
    "dateCreated": "2025-12-19T14:37:18.901Z",
    "dateModified": "2025-12-19T14:37:18.901Z"
  }
}

Delete a Webhook subscription

delete

Authorizations

basic

AuthorizationstringRequired

Path parameters

webhookSubscriptionIdstring · uuidRequired

Responses

204

The resource was deleted successfully.

401

Authentication credentials are missing or incorrect.

403

The requested resource is forbidden.

application/json

404

The requested resource could not be found.

application/json

delete

/webhook_subscriptions/{webhookSubscriptionId}

HTTPcURLJavaScriptPython

DELETE /enterprise/webhook_subscriptions/{webhookSubscriptionId} HTTP/1.1
Host: api.okendo.io
Authorization: Basic username:password
Accept: */*

No content

Rotate a Webhook Subscription Secret

post

Authorizations

basic

AuthorizationstringRequired

Path parameters

webhookSubscriptionIdstring · uuidRequired

Responses

200

An object containing a Webhook Subscription Secret

application/json

401

Authentication credentials are missing or incorrect.

403

The requested resource is forbidden.

application/json

404

The requested resource could not be found.

application/json

post

/webhook_subscriptions/{webhookSubscriptionId}/rotate_secret

HTTPcURLJavaScriptPython

POST /enterprise/webhook_subscriptions/{webhookSubscriptionId}/rotate_secret HTTP/1.1
Host: api.okendo.io
Authorization: Basic username:password
Accept: */*

{
  "webhookSubscriptionSecret": "text"
}