Class WebhookService

constructor

• new WebhookService(httpRequest): WebhookService

• Parameters

  • httpRequest: BaseHttpRequest

  Returns WebhookService

Readonly httpRequest

webhookCreate

• webhookCreate(options): CancelablePromise<{
      webhook: WebhookPayload;
  }>

• Create a webhook

  Throws

  ApiError

  Parameters

  • options: {
        requestBody: {
            channelId: string;
            name: string;
        };
        serverId: string;
    }

    • requestBody: {
          channelId: string;
          name: string;
      }

      • channelId: string

        Channel ID to create the webhook in

      • name: string

        The name of the webhook

    • serverId: string

  Returns CancelablePromise<{
      webhook: WebhookPayload;
  }>

  any Success

webhookDelete

• webhookDelete(options): CancelablePromise<void>

• Delete a server webhook

  Throws

  ApiError

  Parameters

  • options: {
        serverId: string;
        webhookId: string;
    }

    • serverId: string

    • webhookId: string

  Returns CancelablePromise<void>

  void

webhookRead

• webhookRead(options): CancelablePromise<{
      webhook: WebhookPayload;
  }>

• Get a server's webhook

  Throws

  ApiError

  Parameters

  • options: {
        serverId: string;
        webhookId: string;
    }

    • serverId: string

    • webhookId: string

  Returns CancelablePromise<{
      webhook: WebhookPayload;
  }>

  any Success

webhookReadMany

• webhookReadMany(options): CancelablePromise<{
      webhooks: WebhookPayload[];
  }>

• Get a server's webhooks Get a list of webhooks from a server.

  Throws

  ApiError

  Parameters

  • options: {
        channelId: string;
        serverId: string;
    }

    • channelId: string

      ID of the channel you want to filter for webhooks

    • serverId: string

  Returns CancelablePromise<{
      webhooks: WebhookPayload[];
  }>

  any Success

webhookUpdate

• webhookUpdate(options): CancelablePromise<{
      webhook: WebhookPayload;
  }>

• Update a webhook

  Throws

  ApiError

  Parameters

  • options: {
        requestBody: {
            channelId?: string;
            name: string;
        };
        serverId: string;
        webhookId: string;
    }

    • requestBody: {
          channelId?: string;
          name: string;
      }

      • Optional channelId?: string

        The ID of the channel

      • name: string

        The name of the webhook

    • serverId: string

    • webhookId: string

  Returns CancelablePromise<{
      webhook: WebhookPayload;
  }>

  any Success