Class SeamHttpWebhooks

constructor

• new SeamHttpWebhooks(apiKeyOrOptions?): SeamHttpWebhooks

• Parameters

  • apiKeyOrOptions: string | SeamHttpOptions = {}

  Returns SeamHttpWebhooks

client

Readonly defaults

create

• create(body?): Promise<{
      event_types?: string[];
      secret?: string;
      url: string;
      webhook_id: string;
  }>

• Parameters

  • Optional body: {
        event_types?: string[];
        url: string;
    }

    • Optional event_types?: string[]

    • url: string

  Returns Promise<{
      event_types?: string[];
      secret?: string;
      url: string;
      webhook_id: string;
  }>

delete

• delete(body?): Promise<void>

• Parameters

  • Optional body: {
        webhook_id: string;
    }

    • webhook_id: string

  Returns Promise<void>

get

• get(body?): Promise<{
      event_types?: string[];
      secret?: string;
      url: string;
      webhook_id: string;
  }>

• Parameters

  • Optional body: {
        webhook_id: string;
    }

    • webhook_id: string

  Returns Promise<{
      event_types?: string[];
      secret?: string;
      url: string;
      webhook_id: string;
  }>

list

• list(body?): Promise<{
      event_types?: string[];
      secret?: string;
      url: string;
      webhook_id: string;
  }[]>

• Parameters

  • Optional body: {}

  Returns Promise<{
      event_types?: string[];
      secret?: string;
      url: string;
      webhook_id: string;
  }[]>

update

• update(body?): Promise<void>

• Parameters

  • Optional body: {
        event_types: string[];
        webhook_id: string;
    }

    • event_types: string[]

    • webhook_id: string

  Returns Promise<void>

updateClientSessionToken

• updateClientSessionToken(clientSessionToken): Promise<void>

• Parameters

  • clientSessionToken: string

  Returns Promise<void>

Static fromApiKey

• fromApiKey(apiKey, options?): SeamHttpWebhooks

• Parameters

  • apiKey: string
  • options: Omit<SeamHttpOptionsWithApiKey, "apiKey"> = {}

  Returns SeamHttpWebhooks

Static fromClient

• fromClient(client, options?): SeamHttpWebhooks

• Parameters

  • client: AxiosInstance
  • options: Omit<SeamHttpOptionsWithClient, "client"> = {}

  Returns SeamHttpWebhooks

Static fromClientSessionToken

• fromClientSessionToken(clientSessionToken, options?): SeamHttpWebhooks

• Parameters

  • clientSessionToken: string
  • options: Omit<SeamHttpOptionsWithClientSessionToken, "clientSessionToken"> = {}

  Returns SeamHttpWebhooks

Static fromConsoleSessionToken

• fromConsoleSessionToken(consoleSessionToken, workspaceId, options?): SeamHttpWebhooks

• Parameters

  • consoleSessionToken: string
  • workspaceId: string
  • options: Omit<SeamHttpOptionsWithConsoleSessionToken, "consoleSessionToken" | "workspaceId"> = {}

  Returns SeamHttpWebhooks

Static fromPersonalAccessToken

• fromPersonalAccessToken(personalAccessToken, workspaceId, options?): SeamHttpWebhooks

• Parameters

  • personalAccessToken: string
  • workspaceId: string
  • options: Omit<SeamHttpOptionsWithPersonalAccessToken, "workspaceId" | "personalAccessToken"> = {}

  Returns SeamHttpWebhooks

Static fromPublishableKey

• fromPublishableKey(publishableKey, userIdentifierKey, options?): Promise<SeamHttpWebhooks>

• Parameters

  • publishableKey: string
  • userIdentifierKey: string
  • options: SeamHttpFromPublishableKeyOptions = {}

  Returns Promise<SeamHttpWebhooks>