Create

Create

client.webhooks.create(WebhookCreateParamsbody, RequestOptionsoptions?): webhookWebhookWebhookCreateResponse

post/api/v1/webhooks

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

Parameters

bodydisplayNamestringurlstringdescriptionstringWebhookCreateParams

Hide ParametersShow Parameters

displayNamestring

The displayName field.

urlstring

The url field.

descriptionstring

optional

The description field.

Returns

WebhookCreateResponse

The WebhooksServiceCreateResponse message.

Hide ParametersShow Parameters

webhookidstringcreatedAtstringdeletedAtstringdescriptionstringdisplayNamestringupdatedAtstringurlstringWebhook

optional

The Webhook message.

Request example TypeScript

import ConductoroneSDK from 'conductorone-sdk';

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

const webhook = await client.webhooks.create({ displayName: 'displayName', url: 'url' });

console.log(webhook.webhook);

200 Example

{
  "webhook": {
    "id": "id",
    "description": "description",
    "displayName": "displayName",
    "url": "url"
  }
}