List

List

client.webhooks.list(WebhookListParamsquery?, RequestOptionsoptions?): listunionnextPageTokenstringWebhookListResponse

get/api/v1/webhooks

Invokes the c1.api.webhooks.v1.WebhooksService.List method.

Parameters

querypage_sizenumberpage_tokenstringWebhookListParams

Hide ParametersShow Parameters

page_sizenumber

optional

The pageSize field.

formatint32

page_tokenstring

optional

The pageToken field.

Returns

WebhookListResponse

The WebhooksServiceListResponse message.

Hide ParametersShow Parameters

listunion

optional

Array<idstringcreatedAtstringdeletedAtstringdescriptionstringdisplayNamestringupdatedAtstringurlstringWebhook> | null

The list field.

Hide ParametersShow Parameters

idstring

optional

The id field.

createdAtstring

optional

formatdate-time

deletedAtstring

optional

formatdate-time

descriptionstring

optional

The description field.

displayNamestring

optional

The displayName field.

updatedAtstring

optional

formatdate-time

urlstring

optional

The url field.

nextPageTokenstring

optional

The nextPageToken field.

Request example TypeScript

import ConductoroneSDK from 'conductorone-sdk';

const client = new ConductoroneSDK({
  apiKey: 'My API Key',
});

const webhooks = await client.webhooks.list();

console.log(webhooks.list);

200 Example

{
  "list": [
    {
      "id": "id",
      "description": "description",
      "displayName": "displayName",
      "url": "url"
    }
  ],
  "nextPageToken": "nextPageToken"
}