Class WebhookService

constructor

• new WebhookService(httpRequest): WebhookService

• Parameters

  • httpRequest: BaseHttpRequest

  Returns WebhookService

ReadonlyhttpRequest

addWebhookSubscription

• addWebhookSubscription(contractAddress, requestBody): CancelablePromise<{
      webhookSubscriptionId?: string;
  }>

• Add a webhook subscription to a collection

  Parameters

  • contractAddress: string
  • requestBody: NewCollectionWebhookSubscription

    The data for creating or updating a webhook subscription

  Returns CancelablePromise<{
      webhookSubscriptionId?: string;
  }>

  any Response with webhook ID

  Throws

  ApiError

deleteWebhookSubscription

• deleteWebhookSubscription(contractAddress, webhookSubscriptionId): CancelablePromise<{
      success: boolean;
  }>

• Delete a webhook subscription

  Parameters

  • contractAddress: string
  • webhookSubscriptionId: string

    The ID of the webhook subscription.

  Returns CancelablePromise<{
      success: boolean;
  }>

  any Success response

  Throws

  ApiError

getWebhookPublicKey

• getWebhookPublicKey(): CancelablePromise<string>

• Get webhook public key. The webhook public key is used to verify the signature of the webhook payload.

  Returns CancelablePromise<string>

  string Success

  Throws

  ApiError

listWebhookSubscriptions

• listWebhookSubscriptions(contractAddress): CancelablePromise<{
      webhookSubscriptions: CollectionWebhookSubscription[];
  }>

• List all webhook subscriptions of a collection

  Parameters

  • contractAddress: string

  Returns CancelablePromise<{
      webhookSubscriptions: CollectionWebhookSubscription[];
  }>

  any List of all webhook subscriptions for a collection

  Throws

  ApiError

updateWebhookSubscription

• updateWebhookSubscription(contractAddress, webhookSubscriptionId, requestBody): CancelablePromise<{
      success: boolean;
  }>

• Update a webhook subscription from a collection

  Parameters

  • contractAddress: string
  • webhookSubscriptionId: string

    The ID of the webhook subscription.
  • requestBody: NewCollectionWebhookSubscription

    The data for creating or updating a webhook subscription

  Returns CancelablePromise<{
      success: boolean;
  }>

  any Success response

  Throws

  ApiError