Class: Figo::Notification

Inherits:

Base

• Object
• Base
• Figo::Notification

Defined in:

lib/models.rb

Overview

Object representing a configured notification, e.g. a webhook or email hook

Instance Attribute Summary

• #notification_id ⇒ String

  Internal figo Connect notification ID from the notification registration response.

• #notify_uri ⇒ String

  Notification messages will be sent to this URL.

• #observe_key ⇒ String

  One of the notification keys specified in the figo Connect API specification.

• #state ⇒ String

  State similiar to sync and logon process.

Method Summary

Methods inherited from Base

#dump, dump_attributes, #initialize

Constructor Details

This class inherits a constructor from Figo::Base

Instance Attribute Details

#notification_id ⇒ String

Internal figo Connect notification ID from the notification registration response

Returns:

• (String)

# File 'lib/models.rb', line 383

def notification_id
  @notification_id
end

#notify_uri ⇒ String

Notification messages will be sent to this URL

Returns:

• (String)

# File 'lib/models.rb', line 391

def notify_uri
  @notify_uri
end

#observe_key ⇒ String

One of the notification keys specified in the figo Connect API specification

Returns:

• (String)

# File 'lib/models.rb', line 387

def observe_key
  @observe_key
end

#state ⇒ String

State similiar to sync and logon process. It will passed as POST payload for webhooks

Returns:

• (String)

# File 'lib/models.rb', line 395

def state
  @state
end