Class: PlatformAPI::AddonWebhookEvent

Inherits:
Object
  • Object
show all
Defined in:
lib/platform-api/client.rb

Overview

Represents a webhook event that occurred.

Instance Method Summary collapse

Constructor Details

#initialize(client) ⇒ AddonWebhookEvent

Returns a new instance of AddonWebhookEvent.



1051
1052
1053
# File 'lib/platform-api/client.rb', line 1051

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



1059
1060
1061
# File 'lib/platform-api/client.rb', line 1059

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



1066
1067
1068
# File 'lib/platform-api/client.rb', line 1066

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