On this page

New data types

WebhookScopeBranch

Name

Type

Remark

type

ENUM (one of: “branch”)

The scope type.

resourceId

UUID

The ID of the resource that constitutes the scope.

branchId

UUID

The ID of the branch that constitutes the scope.

Affected URLs:

  • /osmc/admin/webhooks
  • /osmc/admin/webhooks/{webhookId}

WebhookScopeEObject                

Name

Type

Remark

type

ENUM (one of: “eobject”)

The scope type.

resourceId

UUID

The ID of the resource that constitutes the scope.

eobjectId

UUID

The ID of the EObject that constitutes the scope.

effective_recursively

Boolean

Determines whether the webhook is effective recursively (is dispatched on contained EObjects changes).

Affected URLs:

  • /osmc/admin/webhooks
  • /osmc/admin/webhooks/{webhookId}

SetOfWebhookScope

Name

Type

Remark

type

ENUM (one of: “list”)

The scope type.

value

Array of WebhookScope

Arbitrary set of webhook scopes.


Affected URLs:

  • /osmc/admin/webhooks
  • /osmc/admin/webhooks/{webhookId}

Changes in data types

WebhookScope

2022xR1                           

2022xR2

One of: WebhookScopeAll, WebhookScopeResource, WebhookScopeResourcesInCategory.

One of: WebhookScopeAll, WebhookScopeResource, WebhookScopeResourcesInCategory, WebhookScopeBranch, WebhookScopeEObject, SetOfWebhookScope.

Affected URLs:

  • /osmc/admin/webhooks
  • /osmc/admin/webhooks/{webhookId}

Webhook

Name

Type

Status

Remark

title                 

String

Added

The webhook title.

Affected URLs:

  • /osmc/admin/webhooks
  • /osmc/admin/webhooks/{webhookId}

WebhookUpdate

Name

Type

Status

Remark

title                 

String

Added

The webhook title.

Affected URLs:

  • /osmc/admin/webhooks
  • /osmc/admin/webhooks/{webhookId}