class PlatformAPI::AddonWebhook

Represents the details of a webhook subscription

Public Class Methods

new(client) click to toggle source
# File lib/platform-api/client.rb, line 1073
def initialize(client)
  @client = client
end

Public Instance Methods

create(addon_id_or_addon_name, body = {}) click to toggle source

Create an add-on webhook subscription. Can only be accessed by the add-on partner providing this add-on.

@param addon_id_or_addon_name: unique identifier of add-on or globally unique name of the add-on @param body: the object to pass as the request payload

# File lib/platform-api/client.rb, line 1081
def create(addon_id_or_addon_name, body = {})
  @client.addon_webhook.create(addon_id_or_addon_name, body)
end
delete(addon_id_or_addon_name, app_webhook_id) click to toggle source

Removes an add-on webhook subscription. Can only be accessed by the add-on partner providing this add-on.

@param addon_id_or_addon_name: unique identifier of add-on or globally unique name of the add-on @param app_webhook_id: the webhook's unique identifier

# File lib/platform-api/client.rb, line 1089
def delete(addon_id_or_addon_name, app_webhook_id)
  @client.addon_webhook.delete(addon_id_or_addon_name, app_webhook_id)
end
info(addon_id_or_addon_name, app_webhook_id) click to toggle source

Returns the info for an add-on webhook subscription. Can only be accessed by the add-on partner providing this add-on.

@param addon_id_or_addon_name: unique identifier of add-on or globally unique name of the add-on @param app_webhook_id: the webhook's unique identifier

# File lib/platform-api/client.rb, line 1097
def info(addon_id_or_addon_name, app_webhook_id)
  @client.addon_webhook.info(addon_id_or_addon_name, app_webhook_id)
end
list(addon_id_or_addon_name) click to toggle source

List all webhook subscriptions for a particular add-on. Can only be accessed by the add-on partner providing this add-on.

@param 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 1104
def list(addon_id_or_addon_name)
  @client.addon_webhook.list(addon_id_or_addon_name)
end
update(addon_id_or_addon_name, app_webhook_id, body = {}) click to toggle source

Updates the details of an add-on webhook subscription. Can only be accessed by the add-on partner providing this add-on.

@param addon_id_or_addon_name: unique identifier of add-on or globally unique name of the add-on @param app_webhook_id: the webhook's unique identifier @param body: the object to pass as the request payload

# File lib/platform-api/client.rb, line 1113
def update(addon_id_or_addon_name, app_webhook_id, body = {})
  @client.addon_webhook.update(addon_id_or_addon_name, app_webhook_id, body)
end