Home
/
Coro public API
/
Coro API reference
/
webhook-configuration
/
Retrieve a webhook configuration

Coro Cybersecurity Public API (v1)


This is the Coro Cybersecurity platform API specification reference.

This section provides a complete reference listing for the Coro Cybersecurity REST API resource model.

About the resource reference

This reference lists all the resources available through the Coro REST API.

Each section relates to a specific resource and provides its name, description, unique URI path, and the list of operations you can perform on it.

For each operation, you can find:

  • A complete description of the action
  • Request parameters
  • A list of potential responses
  • Security (authentication) requirements

The portal also provides code samples and examples for making requests in a number of programming languages, together with samples of the possible response bodies.

In addition to this, Coro provides a Try It feature where you can interact with the API directly through the portal. To use Try It, you'll need to first obtain Client ID and Secret credentials; for more information, see Authentication.

Download OpenAPI description
View and download the Coro API JSON specification
Overview
URL

https://support.coro.net

E-mail

support@coro.net

Terms of Service

Languages
Servers
Coro mock API server

https://docs.coro.net/_mock/api/api-docs/

Coro US API server target URL

https://api.secure.coro.net/

audit-logs

This is the audit log resource.

Operations

authentication

This is the resource for API authentication requests.

Use this resource to validate your identify and to obtain a bearer token to use when accessing other API resources.

Operations

devices

This is the Devices resource.

Use this resource to get details of all protected devices for a particular workspace.

Operations

portal-users

This is the portal user resource.

Use this resource to get details of all portal users added to the specified workspace.

Operations

subscriptions

This is the subscriptions resource.

Use this resource to view and manage workspace subscriptions.

Operations

tickets

This is the Tickets resource.

Use this resource to get details of all tickets stored in the Coro platform for a particular workspace.

Operations

tickets-summary

This is the Tickets Summary resource.

Use this resource to get details of tickets for a particular workspace, grouped by protection component.

Operations

usage

This is the resource for Coro usage.

Use this resource to obtain information about usage

Operations

users

This is the protected user resource.

Use this resource to get details of all protected users added to the specified workspace.

Operations

webhook-configuration

Use this resource to manage or view details of existing webhooks configurations, or to create new webhook configurations.

Operations

Retrieve a webhook configuration

Request

Retrieve the details of a webhook configurations in a specified workspace.

Security
JWT
Path
idstringrequired
Headers
Workspacestringrequired

The workspace identifier, which isolates API requests inside the provided workspace scope.

Example: corodevonmicrosoftcom_TX7T_u
curl -i -X GET \
  'https://docs.coro.net/_mock/api/api-docs/v1/settings/webhooks/{id}' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Workspace: corodevonmicrosoftcom_TX7T_u'

Responses

Success

Bodyapplication/json
idstring
namestring
workspaceIdstring
statusstring

<placeholder>

Enum"enabled""disconnected""disabled"
descriptionstring
applyToAllDescendantsboolean
urlstring
secretstring
headersobject
triggersArray of stringsuniquerequired

<placeholder>

Items Enum"workspaceCreated""workspaceStatusUpdated""subscriptionUpdated""protectedUsersAdded""protectedUsersUpdated""protectedUsersDeleted""protectedDevicesUpdated"
createdinteger(int64)
updatedinteger(int64)
Response
application/json
{
  "id": "string",
  "name": "string",
  "workspaceId": "string",
  "status": "enabled",
  "description": "string",
  "applyToAllDescendants": true,
  "url": "string",
  "secret": "string",
  "headers": {
    "property1": "string",
    "property2": "string"
  },
  "triggers": "workspaceCreated",
  "created": 0,
  "updated": 0
}

Update a webhook configuration

Request

Update the details of a webhook configuration in a specified workspace.

Security
JWT
Path
idstringrequired
Headers
Workspacestringrequired

The workspace identifier, which isolates API requests inside the provided workspace scope.

Example: corodevonmicrosoftcom_TX7T_u
Bodyapplication/jsonrequired
namestringrequired

<placeholder>

descriptionstring

<placeholder>

applyToAllDescendantsbooleanrequired

<placeholder>

urlstringrequired

<placeholder>

secretstringrequired

<placeholder>

headersobject

<placeholder>

triggersArray of stringsuniquerequired

<placeholder>

Items Enum"workspaceCreated.v1""workspaceStatusUpdated.v1""subscriptionUpdated.v1""protectedUsersAdded.v1""protectedUsersUpdated.v1""protectedUsersDeleted.v1""protectedDevicesUpdated.v1""protectedDevicesAdded.v1""protectedDevicesDeleted.v1""protectedDevicesCountUpdated.v1"
statusstringrequired

<placeholder>

Enum"enabled""disabled"
curl -i -X PUT \
  'https://docs.coro.net/_mock/api/api-docs/v1/settings/webhooks/{id}' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -H 'Workspace: corodevonmicrosoftcom_TX7T_u' \
  -d '{
    "name": "string",
    "description": "string",
    "applyToAllDescendants": true,
    "url": "string",
    "secret": "string",
    "headers": {
      "property1": "string",
      "property2": "string"
    },
    "triggers": "workspaceCreated.v1",
    "status": "enabled"
  }'

Responses

Success

Bodyapplication/json
idstring
namestring
workspaceIdstring
statusstring

<placeholder>

Enum"enabled""disconnected""disabled"
descriptionstring
applyToAllDescendantsboolean
urlstring
secretstring
headersobject
triggersArray of stringsuniquerequired

<placeholder>

Items Enum"workspaceCreated""workspaceStatusUpdated""subscriptionUpdated""protectedUsersAdded""protectedUsersUpdated""protectedUsersDeleted""protectedDevicesUpdated"
createdinteger(int64)
updatedinteger(int64)
Response
application/json
{
  "id": "string",
  "name": "string",
  "workspaceId": "string",
  "status": "enabled",
  "description": "string",
  "applyToAllDescendants": true,
  "url": "string",
  "secret": "string",
  "headers": {
    "property1": "string",
    "property2": "string"
  },
  "triggers": "workspaceCreated",
  "created": 0,
  "updated": 0
}

Delete a webhook configuration

Request

Delete a webhook configuration by its unique identifier. This action cannot be undone.

Security
JWT
Path
idstringrequired
Headers
Workspacestringrequired

The workspace identifier, which isolates API requests inside the provided workspace scope.

Example: corodevonmicrosoftcom_TX7T_u
curl -i -X DELETE \
  'https://docs.coro.net/_mock/api/api-docs/v1/settings/webhooks/{id}' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Workspace: corodevonmicrosoftcom_TX7T_u'

Responses

Success

Body*/*
object
Response
No content

Retrieve webhook configurations

Request

Retrieve a list of all the webhooks for a specified workspace.

Security
JWT
Headers
Workspacestringrequired

The workspace identifier, which isolates API requests inside the provided workspace scope.

Example: corodevonmicrosoftcom_TX7T_u
curl -i -X GET \
  https://docs.coro.net/_mock/api/api-docs/v1/settings/webhooks \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Workspace: corodevonmicrosoftcom_TX7T_u'

Responses

Success

Bodyapplication/json
idstring
namestring
workspaceIdstring
statusstring

<placeholder>

Enum"enabled""disconnected""disabled"
descriptionstring
applyToAllDescendantsboolean
urlstring
secretstring
headersobject
triggersArray of stringsuniquerequired

<placeholder>

Items Enum"workspaceCreated""workspaceStatusUpdated""subscriptionUpdated""protectedUsersAdded""protectedUsersUpdated""protectedUsersDeleted""protectedDevicesUpdated"
createdinteger(int64)
updatedinteger(int64)
Response
application/json
{
  "id": "string",
  "name": "string",
  "workspaceId": "string",
  "status": "enabled",
  "description": "string",
  "applyToAllDescendants": true,
  "url": "string",
  "secret": "string",
  "headers": {
    "property1": "string",
    "property2": "string"
  },
  "triggers": "workspaceCreated",
  "created": 0,
  "updated": 0
}

Create a webhook configuration

Request

Create a new webhook configuration for a specified workspace.

Security
JWT
Headers
Workspacestringrequired

The workspace identifier, which isolates API requests inside the provided workspace scope.

Example: corodevonmicrosoftcom_TX7T_u
Bodyapplication/jsonrequired
namestringrequired

<placeholder>

descriptionstring

<placeholder>

applyToAllDescendantsbooleanrequired

<placeholder>

urlstringrequired

<placeholder>

secretstringrequired

<placeholder>

headersobject

<placeholder>

triggersArray of stringsuniquerequired

<placeholder>

Items Enum"workspaceCreated.v1""workspaceStatusUpdated.v1""subscriptionUpdated.v1""protectedUsersAdded.v1""protectedUsersUpdated.v1""protectedUsersDeleted.v1""protectedDevicesUpdated.v1""protectedDevicesAdded.v1""protectedDevicesDeleted.v1""protectedDevicesCountUpdated.v1"
curl -i -X POST \
  https://docs.coro.net/_mock/api/api-docs/v1/settings/webhooks \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -H 'Workspace: corodevonmicrosoftcom_TX7T_u' \
  -d '{
    "name": "string",
    "description": "string",
    "applyToAllDescendants": true,
    "url": "string",
    "secret": "string",
    "headers": {
      "property1": "string",
      "property2": "string"
    },
    "triggers": "workspaceCreated.v1"
  }'

Responses

Created

Bodyapplication/json
idstring
namestring
workspaceIdstring
statusstring

<placeholder>

Enum"enabled""disconnected""disabled"
descriptionstring
applyToAllDescendantsboolean
urlstring
secretstring
headersobject
triggersArray of stringsuniquerequired

<placeholder>

Items Enum"workspaceCreated""workspaceStatusUpdated""subscriptionUpdated""protectedUsersAdded""protectedUsersUpdated""protectedUsersDeleted""protectedDevicesUpdated"
createdinteger(int64)
updatedinteger(int64)
Response
application/json
{
  "id": "string",
  "name": "string",
  "workspaceId": "string",
  "status": "enabled",
  "description": "string",
  "applyToAllDescendants": true,
  "url": "string",
  "secret": "string",
  "headers": {
    "property1": "string",
    "property2": "string"
  },
  "triggers": "workspaceCreated",
  "created": 0,
  "updated": 0
}

Test a webhook configuration

Request

Test that a webhook can be sent successfully

Security
JWT
Path
idstringrequired
Query
triggerstring
versionstring
Headers
Workspacestringrequired

The workspace identifier, which isolates API requests inside the provided workspace scope.

Example: corodevonmicrosoftcom_TX7T_u
curl -i -X GET \
  'https://docs.coro.net/_mock/api/api-docs/v1/settings/webhooks/{id}/test?trigger=string&version=string' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Workspace: corodevonmicrosoftcom_TX7T_u'

Responses

Success

Body*/*
string
Enum"100 CONTINUE""101 SWITCHING_PROTOCOLS""102 PROCESSING""103 EARLY_HINTS""103 CHECKPOINT""200 OK""201 CREATED""202 ACCEPTED""203 NON_AUTHORITATIVE_INFORMATION""204 NO_CONTENT"
Response
No content

workspaces

Use this resource to view details of provisioned workspaces, or to create new workspaces.

Operations