Skip to content

Latest commit

 

History

History
78 lines (52 loc) · 3.34 KB

WebhookSecretKeyService.md

File metadata and controls

78 lines (52 loc) · 3.34 KB

WebhookSecretKeyService

A list of all methods in the WebhookSecretKeyService service. Click on the method name to view detailed information about that method.

Methods Description
getWebhookSecretKey Gets the webhook secret key
updateWebhookSecretKey Updates the webhook secret key

getWebhookSecretKey

Gets the webhook secret key

  • HTTP Method: GET
  • Endpoint: /organizations/{organization_name}/webhook-secret-key

Parameters

Name Type Required Description
organizationName string Your organization name. This identifies the billing context for the API operation and represents a security boundary for SaladCloud resources. The organization must be created before using the API, and you must be a member of the organization.

Return Type

WebhookSecretKey

Example Usage Code Snippet

import { SaladCloudSdk } from '@saladtechnologies-oss/salad-cloud-sdk';

(async () => {
  const saladCloudSdk = new SaladCloudSdk({
    apiKey: 'YOUR_API_KEY',
  });

  const { data } = await saladCloudSdk.webhookSecretKey.getWebhookSecretKey(
    'mouv4w914sp420zyiuo43jexocjzq6rnxf04dqmccakipx9g3a72svbj',
  );

  console.log(data);
})();

updateWebhookSecretKey

Updates the webhook secret key

  • HTTP Method: POST
  • Endpoint: /organizations/{organization_name}/webhook-secret-key

Parameters

Name Type Required Description
organizationName string Your organization name. This identifies the billing context for the API operation and represents a security boundary for SaladCloud resources. The organization must be created before using the API, and you must be a member of the organization.

Return Type

WebhookSecretKey

Example Usage Code Snippet

import { SaladCloudSdk } from '@saladtechnologies-oss/salad-cloud-sdk';

(async () => {
  const saladCloudSdk = new SaladCloudSdk({
    apiKey: 'YOUR_API_KEY',
  });

  const { data } = await saladCloudSdk.webhookSecretKey.updateWebhookSecretKey(
    'mouv4w914sp420zyiuo43jexocjzq6rnxf04dqmccakipx9g3a72svbj',
  );

  console.log(data);
})();