Class: PlatformAPI::AddonWebhookEvent

Inherits:

Object

• Object
• PlatformAPI::AddonWebhookEvent

Defined in:

lib/platform-api/client.rb

Overview

Represents a webhook event that occurred.

Instance Method Summary

• #info(addon_id_or_addon_name, app_webhook_event_id) ⇒ Object

  Returns the info for a specified webhook event.

• #initialize(client) ⇒ AddonWebhookEvent constructor

  A new instance of AddonWebhookEvent.

• #list(addon_id_or_addon_name) ⇒ Object

  Lists existing webhook events for an add-on.

Constructor Details

#initialize(client) ⇒ AddonWebhookEvent

Returns a new instance of AddonWebhookEvent.

# File 'lib/platform-api/client.rb', line 1056

def initialize(client)
  @client = client
end

Instance Method Details

#info(addon_id_or_addon_name, app_webhook_event_id) ⇒ Object

Returns the info for a specified webhook event. Can only be accessed by the add-on partner providing this add-on.

Parameters:

• addon_id_or_addon_name: —

  unique identifier of add-on or globally unique name of the add-on

• app_webhook_event_id: —

  the event's unique identifier

# File 'lib/platform-api/client.rb', line 1064

def info(addon_id_or_addon_name, app_webhook_event_id)
  @client.addon_webhook_event.info(addon_id_or_addon_name, app_webhook_event_id)
end

#list(addon_id_or_addon_name) ⇒ Object

Lists existing webhook events for an add-on. Can only be accessed by the add-on partner providing this add-on.

Parameters:

• addon_id_or_addon_name: —

  unique identifier of add-on or globally unique name of the add-on

# File 'lib/platform-api/client.rb', line 1071

def list(addon_id_or_addon_name)
  @client.addon_webhook_event.list(addon_id_or_addon_name)
end