Class: LockstepSdk::WebhookModel

Inherits:
Object
  • Object
show all
Defined in:
lib/lockstep_sdk/models/webhook_model.rb

Overview

A Webhook is a subscription to receive notifications automatically to the supplied callback url when changes are made to a supported object.

Currently supported objects:

* `SyncRequest` - Receive a notification when a new sync request has completed for the group key.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(params = {}) ⇒ WebhookModel

Initialize the WebhookModel using the provided prototype



31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
 
# File 'lib/lockstep_sdk/models/webhook_model.rb', line 31

def initialize(params = {})
    @webhook_id = params.dig(:webhook_id)
    @group_key = params.dig(:group_key)
    @name = params.dig(:name)
    @status_code = params.dig(:status_code)
    @status_message = params.dig(:status_message)
    @client_secret = params.dig(:client_secret)
    @request_content_type = params.dig(:request_content_type)
    @callback_http_method = params.dig(:callback_http_method)
    @callback_url = params.dig(:callback_url)
    @expiration_date = params.dig(:expiration_date)
    @retry_count = params.dig(:retry_count)
    @created = params.dig(:created)
    @created_user_id = params.dig(:created_user_id)
    @modified = params.dig(:modified)
    @modified_user_id = params.dig(:modified_user_id)
end

Instance Attribute Details

#callback_http_method ⇒ String

Returns The HTTP Method to be used on the callback URL for use in notifications (GET, POST, PATCH, PUT).

Returns:

  • (String) —

    The HTTP Method to be used on the callback URL for use in notifications (GET, POST, PATCH, PUT).



79
80
81
 
# File 'lib/lockstep_sdk/models/webhook_model.rb', line 79

def callback_http_method
  @callback_http_method
end

#callback_url ⇒ Uri

Returns The URL where the notification will be sent via the method set in CallbackHttpMethod. When creating a webhook, the Lockstep API will make a call to this url via the method set in the CallbackHttpMethod property with a query parameter of “code” set to an encoded string. To successfully create the webhook, the call must return a successful status code with the query parameter’s value as the plain text content.

Returns:

  • (Uri) —

    The URL where the notification will be sent via the method set in CallbackHttpMethod. When creating a webhook, the Lockstep API will make a call to this url via the method set in the CallbackHttpMethod property with a query parameter of “code” set to an encoded string. To successfully create the webhook, the call must return a successful status code with the query parameter’s value as the plain text content.



83
84
85
 
# File 'lib/lockstep_sdk/models/webhook_model.rb', line 83

def callback_url
  @callback_url
end

#client_secret ⇒ String

Returns An secret set during webhook creation that can be used to verify that the notification is coming from the Lockstep API.

Returns:

  • (String) —

    An secret set during webhook creation that can be used to verify that the notification is coming from the Lockstep API.



71
72
73
 
# File 'lib/lockstep_sdk/models/webhook_model.rb', line 71

def client_secret
  @client_secret
end

#created ⇒ Date-time

Returns The date this webhook was created.

Returns:

  • (Date-time) —

    The date this webhook was created



95
96
97
 
# File 'lib/lockstep_sdk/models/webhook_model.rb', line 95

def created
  @created
end

#created_user_id ⇒ Uuid

Returns The ID of the user who created this webhook.

Returns:

  • (Uuid) —

    The ID of the user who created this webhook



99
100
101
 
# File 'lib/lockstep_sdk/models/webhook_model.rb', line 99

def created_user_id
  @created_user_id
end

#expiration_date ⇒ Date-time

Returns The expiration date for the given webhook subscription. Once the expiration date passes, notifications will no longer be sent to the callback url.

Returns:

  • (Date-time) —

    The expiration date for the given webhook subscription. Once the expiration date passes, notifications will no longer be sent to the callback url.



87
88
89
 
# File 'lib/lockstep_sdk/models/webhook_model.rb', line 87

def expiration_date
  @expiration_date
end

#group_key ⇒ Uuid

Returns The GroupKey uniquely identifies a single Lockstep Platform account. All records for this account will share the same GroupKey value. GroupKey values cannot be changed once created. For more information, see [Accounts and GroupKeys](developer.lockstep.io/docs/accounts-and-groupkeys).

Returns:

  • (Uuid) —

    The GroupKey uniquely identifies a single Lockstep Platform account. All records for this account will share the same GroupKey value. GroupKey values cannot be changed once created. For more information, see [Accounts and GroupKeys](developer.lockstep.io/docs/accounts-and-groupkeys).



55
56
57
 
# File 'lib/lockstep_sdk/models/webhook_model.rb', line 55

def group_key
  @group_key
end

#modified ⇒ Date-time

Returns The date this webhook was last modified.

Returns:

  • (Date-time) —

    The date this webhook was last modified



103
104
105
 
# File 'lib/lockstep_sdk/models/webhook_model.rb', line 103

def modified
  @modified
end

#modified_user_id ⇒ Uuid

Returns The ID of the user who last modified this webhook.

Returns:

  • (Uuid) —

    The ID of the user who last modified this webhook



107
108
109
 
# File 'lib/lockstep_sdk/models/webhook_model.rb', line 107

def modified_user_id
  @modified_user_id
end

#name ⇒ String

Returns A name for the webhook subscription.

Returns:

  • (String) —

    A name for the webhook subscription.



59
60
61
 
# File 'lib/lockstep_sdk/models/webhook_model.rb', line 59

def name
  @name
end

#request_content_type ⇒ String

Returns The format of the content to be returned in the webhook notifications. Options TBD.

Returns:

  • (String) —

    The format of the content to be returned in the webhook notifications. Options TBD.



75
76
77
 
# File 'lib/lockstep_sdk/models/webhook_model.rb', line 75

def request_content_type
  @request_content_type
end

#retry_count ⇒ Int32

Returns The amount of times a notification should be retried before marking the webhook as errored.

Returns:

  • (Int32) —

    The amount of times a notification should be retried before marking the webhook as errored.



91
92
93
 
# File 'lib/lockstep_sdk/models/webhook_model.rb', line 91

def retry_count
  @retry_count
end

#status_code ⇒ String

Returns The status of the webhook (Active, Inactive, Errored).

Returns:

  • (String) —

    The status of the webhook (Active, Inactive, Errored).



63
64
65
 
# File 'lib/lockstep_sdk/models/webhook_model.rb', line 63

def status_code
  @status_code
end

#status_message ⇒ String

Returns When the StatusCode is set to Errored a message is supplied for why it was errored.

Returns:

  • (String) —

    When the StatusCode is set to Errored a message is supplied for why it was errored.



67
68
69
 
# File 'lib/lockstep_sdk/models/webhook_model.rb', line 67

def status_message
  @status_message
end

#webhook_id ⇒ Uuid

Returns The unique ID of this record, automatically assigned by Lockstep when this record is added to the Lockstep platform.

Returns:

  • (Uuid) —

    The unique ID of this record, automatically assigned by Lockstep when this record is added to the Lockstep platform.



51
52
53
 
# File 'lib/lockstep_sdk/models/webhook_model.rb', line 51

def webhook_id
  @webhook_id
end

Instance Method Details

#as_json(options = {}) ⇒ object

Returns This object as a JSON key-value structure.

Returns:

  • (object) —

    This object as a JSON key-value structure



111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
 
# File 'lib/lockstep_sdk/models/webhook_model.rb', line 111

def as_json(options={})
    {
        'webhookId' => @webhook_id,
        'groupKey' => @group_key,
        'name' => @name,
        'statusCode' => @status_code,
        'statusMessage' => @status_message,
        'clientSecret' => @client_secret,
        'requestContentType' => @request_content_type,
        'callbackHttpMethod' => @callback_http_method,
        'callbackUrl' => @callback_url,
        'expirationDate' => @expiration_date,
        'retryCount' => @retry_count,
        'created' => @created,
        'createdUserId' => @created_user_id,
        'modified' => @modified,
        'modifiedUserId' => @modified_user_id,
    }
end

#to_json(*options) ⇒ String

Returns This object converted to a JSON string.

Returns:

  • (String) —

    This object converted to a JSON string



133
134
135
 
# File 'lib/lockstep_sdk/models/webhook_model.rb', line 133

def to_json(*options)
    "[#{as_json(*options).to_json(*options)}]"
end