Class: PlatformAPI::AppWebhookEvent

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) ⇒ AppWebhookEvent

Returns a new instance of AppWebhookEvent.



1338
1339
1340
# File 'lib/platform-api/client.rb', line 1338

def initialize(client)
  @client = client
end

Instance Method Details

#info(app_id_or_app_name, app_webhook_event_id) ⇒ Object

Returns the info for a specified webhook event.

Parameters:

  • app_id_or_app_name:

    unique identifier of app or unique name of app

  • app_webhook_event_id:

    the event's unique identifier



1346
1347
1348
# File 'lib/platform-api/client.rb', line 1346

def info(app_id_or_app_name, app_webhook_event_id)
  @client.app_webhook_event.info(app_id_or_app_name, app_webhook_event_id)
end

#list(app_id_or_app_name) ⇒ Object

Lists existing webhook events for an app.

Parameters:

  • app_id_or_app_name:

    unique identifier of app or unique name of app



1353
1354
1355
# File 'lib/platform-api/client.rb', line 1353

def list(app_id_or_app_name)
  @client.app_webhook_event.list(app_id_or_app_name)
end