SyncteraRubySdk::WebhooksApi

All URIs are relative to https://api.synctera.com/v0

Method	HTTP request	Description
create_secret	POST /webhook_secrets	Create a secret
create_webhook	POST /webhooks	Create a webhook
delete_webhook	DELETE /webhooks/webhook_id	Delete a webhook
get_event	GET /webhooks/webhook_id/events/event_id	Get webhook event
get_webhook	GET /webhooks/webhook_id	Get a webhook
list_events	GET /webhooks/webhook_id/events	List webhook events
list_webhooks	GET /webhooks	List webhooks
replace_secret	PUT /webhook_secrets	Replace an existing secret
resend_event	POST /webhooks/webhook_id/events/event_id/resend	Resend an event
revoke_secret	DELETE /webhook_secrets	Revoke the secret
trigger_event	POST /webhooks/trigger	Trigger an event
update_webhook	PUT /webhooks/webhook_id	Update a webhook

create_secret

create_secret

Create a secret

Create a webhook secret. The secret will be used to verify all subsequent webhook request signature.

Examples

require 'time'
require 'synctera_ruby_sdk'
# setup authorization
SyncteraRubySdk.configure do |config|
  # Configure Bearer authorization (api_key): bearerAuth
  config.access_token = 'YOUR_BEARER_TOKEN'
end

api_instance = SyncteraRubySdk::WebhooksApi.new

begin
  # Create a secret
  result = api_instance.create_secret
  p result
rescue SyncteraRubySdk::ApiError => e
  puts "Error when calling WebhooksApi->create_secret: #{e}"
end

Using the create_secret_with_http_info variant

This returns an Array which contains the response data, status code and headers.

, Integer, Hash)> create_secret_with_http_info

begin
  # Create a secret
  data, status_code, headers = api_instance.create_secret_with_http_info
  p status_code # => 2xx
  p headers # => { ... }
  p data # => <CreateSecret201Response>
rescue SyncteraRubySdk::ApiError => e
  puts "Error when calling WebhooksApi->create_secret_with_http_info: #{e}"
end

Parameters

This endpoint does not need any parameter.

Return type

CreateSecret201Response

Authorization

bearerAuth

HTTP request headers

• Content-Type: Not defined
• Accept: application/json, application/problem+json

create_webhook

create_webhook(webhook)

Create a webhook

Create a webhook

Examples

require 'time'
require 'synctera_ruby_sdk'
# setup authorization
SyncteraRubySdk.configure do |config|
  # Configure Bearer authorization (api_key): bearerAuth
  config.access_token = 'YOUR_BEARER_TOKEN'
end

api_instance = SyncteraRubySdk::WebhooksApi.new
webhook = SyncteraRubySdk::Webhook.new({enabled_events: [SyncteraRubySdk::EventTypeExplicit::ACCOUNT_CREATED], is_enabled: false, url: 'url_example'}) # Webhook | Webhook to create

begin
  # Create a webhook
  result = api_instance.create_webhook(webhook)
  p result
rescue SyncteraRubySdk::ApiError => e
  puts "Error when calling WebhooksApi->create_webhook: #{e}"
end

Using the create_webhook_with_http_info variant

This returns an Array which contains the response data, status code and headers.

, Integer, Hash)> create_webhook_with_http_info(webhook)

begin
  # Create a webhook
  data, status_code, headers = api_instance.create_webhook_with_http_info(webhook)
  p status_code # => 2xx
  p headers # => { ... }
  p data # => <Webhook>
rescue SyncteraRubySdk::ApiError => e
  puts "Error when calling WebhooksApi->create_webhook_with_http_info: #{e}"
end

Parameters

Name	Type	Description	Notes
webhook	Webhook	Webhook to create

Return type

Webhook

Authorization

bearerAuth

HTTP request headers

• Content-Type: application/json
• Accept: application/json, application/problem+json

delete_webhook

delete_webhook(webhook_id)

Delete a webhook

Delete a webhook

Examples

require 'time'
require 'synctera_ruby_sdk'
# setup authorization
SyncteraRubySdk.configure do |config|
  # Configure Bearer authorization (api_key): bearerAuth
  config.access_token = 'YOUR_BEARER_TOKEN'
end

api_instance = SyncteraRubySdk::WebhooksApi.new
webhook_id = 'b01db9c7-78f2-4a99-8aca-1231d32f9b96' # String | Webhook ID

begin
  # Delete a webhook
  result = api_instance.delete_webhook(webhook_id)
  p result
rescue SyncteraRubySdk::ApiError => e
  puts "Error when calling WebhooksApi->delete_webhook: #{e}"
end

Using the delete_webhook_with_http_info variant

This returns an Array which contains the response data, status code and headers.

, Integer, Hash)> delete_webhook_with_http_info(webhook_id)

begin
  # Delete a webhook
  data, status_code, headers = api_instance.delete_webhook_with_http_info(webhook_id)
  p status_code # => 2xx
  p headers # => { ... }
  p data # => <DeleteResponse>
rescue SyncteraRubySdk::ApiError => e
  puts "Error when calling WebhooksApi->delete_webhook_with_http_info: #{e}"
end

Parameters

Name	Type	Description	Notes
webhook_id	String	Webhook ID

Return type

DeleteResponse

Authorization

bearerAuth

HTTP request headers

• Content-Type: Not defined
• Accept: application/json, application/problem+json

get_event

get_event(webhook_id, event_id)

Get webhook event

Get webhook event by ID

Examples

require 'time'
require 'synctera_ruby_sdk'
# setup authorization
SyncteraRubySdk.configure do |config|
  # Configure Bearer authorization (api_key): bearerAuth
  config.access_token = 'YOUR_BEARER_TOKEN'
end

api_instance = SyncteraRubySdk::WebhooksApi.new
webhook_id = 'b01db9c7-78f2-4a99-8aca-1231d32f9b96' # String | Webhook ID
event_id = 'b01db9c7-78f2-4a99-8aca-1231d32f9b96' # String | Webhook event ID

begin
  # Get webhook event
  result = api_instance.get_event(webhook_id, event_id)
  p result
rescue SyncteraRubySdk::ApiError => e
  puts "Error when calling WebhooksApi->get_event: #{e}"
end

Using the get_event_with_http_info variant

This returns an Array which contains the response data, status code and headers.

, Integer, Hash)> get_event_with_http_info(webhook_id, event_id)

begin
  # Get webhook event
  data, status_code, headers = api_instance.get_event_with_http_info(webhook_id, event_id)
  p status_code # => 2xx
  p headers # => { ... }
  p data # => <Event>
rescue SyncteraRubySdk::ApiError => e
  puts "Error when calling WebhooksApi->get_event_with_http_info: #{e}"
end

Parameters

Name	Type	Description	Notes
webhook_id	String	Webhook ID
event_id	String	Webhook event ID

Return type

Event

Authorization

bearerAuth

HTTP request headers

• Content-Type: Not defined
• Accept: application/json, application/problem+json

get_webhook

get_webhook(webhook_id)

Get a webhook

Get a webhook

Examples

require 'time'
require 'synctera_ruby_sdk'
# setup authorization
SyncteraRubySdk.configure do |config|
  # Configure Bearer authorization (api_key): bearerAuth
  config.access_token = 'YOUR_BEARER_TOKEN'
end

api_instance = SyncteraRubySdk::WebhooksApi.new
webhook_id = 'b01db9c7-78f2-4a99-8aca-1231d32f9b96' # String | Webhook ID

begin
  # Get a webhook
  result = api_instance.get_webhook(webhook_id)
  p result
rescue SyncteraRubySdk::ApiError => e
  puts "Error when calling WebhooksApi->get_webhook: #{e}"
end

Using the get_webhook_with_http_info variant

This returns an Array which contains the response data, status code and headers.

, Integer, Hash)> get_webhook_with_http_info(webhook_id)

begin
  # Get a webhook
  data, status_code, headers = api_instance.get_webhook_with_http_info(webhook_id)
  p status_code # => 2xx
  p headers # => { ... }
  p data # => <Webhook>
rescue SyncteraRubySdk::ApiError => e
  puts "Error when calling WebhooksApi->get_webhook_with_http_info: #{e}"
end

Parameters

Name	Type	Description	Notes
webhook_id	String	Webhook ID

Return type

Webhook

Authorization

bearerAuth

HTTP request headers

• Content-Type: Not defined
• Accept: application/json, application/problem+json

list_events

list_events(webhook_id, opts)

List webhook events

List webhook events. This response will not associate with the event response history.

Examples

require 'time'
require 'synctera_ruby_sdk'
# setup authorization
SyncteraRubySdk.configure do |config|
  # Configure Bearer authorization (api_key): bearerAuth
  config.access_token = 'YOUR_BEARER_TOKEN'
end

api_instance = SyncteraRubySdk::WebhooksApi.new
webhook_id = 'b01db9c7-78f2-4a99-8aca-1231d32f9b96' # String | Webhook ID
opts = {
  start_date: Date.parse('2013-10-20'), # Date | Start date of date range filtering for events. Date is inclusive and should be in UTC timezone 00:00:00.. start_date is alias of start_time and is deprecated. Please use start_time instead.
  end_date: Date.parse('2013-10-20'), # Date | End date of date range filtering for events. Date is inclusive and should be in UTC timezone 00:00:00.. end_date is alias of end_time and is deprecated. Please use end_time instead.
  start_time: Time.parse('2013-10-20T19:20:30+01:00'), # Time | Start time of date-time range filtering for events. Date is inclusive and should be in UTC timezone 00:00:00.
  end_time: Time.parse('2013-10-20T19:20:30+01:00'), # Time | End time of date-time range filtering for events. Date is inclusive and should be in UTC timezone 00:00:00.
  limit: 100, # Integer | 
  page_token: 'a8937a0d' # String | 
}

begin
  # List webhook events
  result = api_instance.list_events(webhook_id, opts)
  p result
rescue SyncteraRubySdk::ApiError => e
  puts "Error when calling WebhooksApi->list_events: #{e}"
end

Using the list_events_with_http_info variant

This returns an Array which contains the response data, status code and headers.

, Integer, Hash)> list_events_with_http_info(webhook_id, opts)

begin
  # List webhook events
  data, status_code, headers = api_instance.list_events_with_http_info(webhook_id, opts)
  p status_code # => 2xx
  p headers # => { ... }
  p data # => <EventList>
rescue SyncteraRubySdk::ApiError => e
  puts "Error when calling WebhooksApi->list_events_with_http_info: #{e}"
end

Parameters

Name	Type	Description	Notes
webhook_id	String	Webhook ID
start_date	Date	Start date of date range filtering for events. Date is inclusive and should be in UTC timezone 00:00:00.. start_date is alias of start_time and is deprecated. Please use start_time instead.	[optional]
end_date	Date	End date of date range filtering for events. Date is inclusive and should be in UTC timezone 00:00:00.. end_date is alias of end_time and is deprecated. Please use end_time instead.	[optional]
start_time	Time	Start time of date-time range filtering for events. Date is inclusive and should be in UTC timezone 00:00:00.	[optional]
end_time	Time	End time of date-time range filtering for events. Date is inclusive and should be in UTC timezone 00:00:00.	[optional]
limit	Integer		[optional][default to 100]
page_token	String		[optional]

Return type

EventList

Authorization

bearerAuth

HTTP request headers

• Content-Type: Not defined
• Accept: application/json, application/problem+json

list_webhooks

list_webhooks(opts)

List webhooks

List all webhooks

Examples

require 'time'
require 'synctera_ruby_sdk'
# setup authorization
SyncteraRubySdk.configure do |config|
  # Configure Bearer authorization (api_key): bearerAuth
  config.access_token = 'YOUR_BEARER_TOKEN'
end

api_instance = SyncteraRubySdk::WebhooksApi.new
opts = {
  limit: 100, # Integer | 
  page_token: 'a8937a0d', # String | 
  is_enabled_only: true # Boolean | 
}

begin
  # List webhooks
  result = api_instance.list_webhooks(opts)
  p result
rescue SyncteraRubySdk::ApiError => e
  puts "Error when calling WebhooksApi->list_webhooks: #{e}"
end

Using the list_webhooks_with_http_info variant

This returns an Array which contains the response data, status code and headers.

, Integer, Hash)> list_webhooks_with_http_info(opts)

begin
  # List webhooks
  data, status_code, headers = api_instance.list_webhooks_with_http_info(opts)
  p status_code # => 2xx
  p headers # => { ... }
  p data # => <WebhookList>
rescue SyncteraRubySdk::ApiError => e
  puts "Error when calling WebhooksApi->list_webhooks_with_http_info: #{e}"
end

Parameters

Name	Type	Description	Notes
limit	Integer		[optional][default to 100]
page_token	String		[optional]
is_enabled_only	Boolean		[optional]

Return type

WebhookList

Authorization

bearerAuth

HTTP request headers

• Content-Type: Not defined
• Accept: application/json, application/problem+json

replace_secret

replace_secret(replace_secret_request)

Replace an existing secret

Replace an existing webhook secret immediately or as part of rotation. This new secret will be used to verify all subsequent webhook request signature.

Examples

require 'time'
require 'synctera_ruby_sdk'
# setup authorization
SyncteraRubySdk.configure do |config|
  # Configure Bearer authorization (api_key): bearerAuth
  config.access_token = 'YOUR_BEARER_TOKEN'
end

api_instance = SyncteraRubySdk::WebhooksApi.new
replace_secret_request = SyncteraRubySdk::ReplaceSecretRequest.new # ReplaceSecretRequest | 

begin
  # Replace an existing secret
  result = api_instance.replace_secret(replace_secret_request)
  p result
rescue SyncteraRubySdk::ApiError => e
  puts "Error when calling WebhooksApi->replace_secret: #{e}"
end

Using the replace_secret_with_http_info variant

This returns an Array which contains the response data, status code and headers.

, Integer, Hash)> replace_secret_with_http_info(replace_secret_request)

begin
  # Replace an existing secret
  data, status_code, headers = api_instance.replace_secret_with_http_info(replace_secret_request)
  p status_code # => 2xx
  p headers # => { ... }
  p data # => <ReplaceSecret200Response>
rescue SyncteraRubySdk::ApiError => e
  puts "Error when calling WebhooksApi->replace_secret_with_http_info: #{e}"
end

Parameters

Name	Type	Description	Notes
replace_secret_request	ReplaceSecretRequest

Return type

ReplaceSecret200Response

Authorization

bearerAuth

HTTP request headers

• Content-Type: application/json
• Accept: application/json, application/problem+json

resend_event

resend_event(webhook_id, event_id, opts)

Resend an event

Resend a webhook event

Examples

require 'time'
require 'synctera_ruby_sdk'
# setup authorization
SyncteraRubySdk.configure do |config|
  # Configure Bearer authorization (api_key): bearerAuth
  config.access_token = 'YOUR_BEARER_TOKEN'
end

api_instance = SyncteraRubySdk::WebhooksApi.new
webhook_id = 'b01db9c7-78f2-4a99-8aca-1231d32f9b96' # String | Webhook ID
event_id = 'b01db9c7-78f2-4a99-8aca-1231d32f9b96' # String | Webhook event ID
opts = {
  delay: 56 # Integer | Delay the event triggering in seconds. Events are checked once a minute, so a short delay may not result in an immedidate resend.
}

begin
  # Resend an event
  result = api_instance.resend_event(webhook_id, event_id, opts)
  p result
rescue SyncteraRubySdk::ApiError => e
  puts "Error when calling WebhooksApi->resend_event: #{e}"
end

Using the resend_event_with_http_info variant

This returns an Array which contains the response data, status code and headers.

, Integer, Hash)> resend_event_with_http_info(webhook_id, event_id, opts)

begin
  # Resend an event
  data, status_code, headers = api_instance.resend_event_with_http_info(webhook_id, event_id, opts)
  p status_code # => 2xx
  p headers # => { ... }
  p data # => <Event>
rescue SyncteraRubySdk::ApiError => e
  puts "Error when calling WebhooksApi->resend_event_with_http_info: #{e}"
end

Parameters

Name	Type	Description	Notes
webhook_id	String	Webhook ID
event_id	String	Webhook event ID
delay	Integer	Delay the event triggering in seconds. Events are checked once a minute, so a short delay may not result in an immedidate resend.	[optional]

Return type

Event

Authorization

bearerAuth

HTTP request headers

• Content-Type: Not defined
• Accept: application/json, application/problem+json

revoke_secret

revoke_secret(opts)

Revoke the secret

Revoke the existing webhook secret. If this is called at the rolling secret time, then both old and new secrets will be revoked

Examples

require 'time'
require 'synctera_ruby_sdk'
# setup authorization
SyncteraRubySdk.configure do |config|
  # Configure Bearer authorization (api_key): bearerAuth
  config.access_token = 'YOUR_BEARER_TOKEN'
end

api_instance = SyncteraRubySdk::WebhooksApi.new
opts = {
  old_secret_only: true # Boolean | 
}

begin
  # Revoke the secret
  api_instance.revoke_secret(opts)
rescue SyncteraRubySdk::ApiError => e
  puts "Error when calling WebhooksApi->revoke_secret: #{e}"
end

Using the revoke_secret_with_http_info variant

This returns an Array which contains the response data (nil in this case), status code and headers.

revoke_secret_with_http_info(opts)

begin
  # Revoke the secret
  data, status_code, headers = api_instance.revoke_secret_with_http_info(opts)
  p status_code # => 2xx
  p headers # => { ... }
  p data # => nil
rescue SyncteraRubySdk::ApiError => e
  puts "Error when calling WebhooksApi->revoke_secret_with_http_info: #{e}"
end

Parameters

Name	Type	Description	Notes
old_secret_only	Boolean		[optional]

Return type

nil (empty response body)

Authorization

bearerAuth

HTTP request headers

• Content-Type: Not defined
• Accept: application/problem+json

trigger_event

trigger_event(trigger_event_request)

Trigger an event

Trigger an specific event for webhook testing purpose

Examples

require 'time'
require 'synctera_ruby_sdk'
# setup authorization
SyncteraRubySdk.configure do |config|
  # Configure Bearer authorization (api_key): bearerAuth
  config.access_token = 'YOUR_BEARER_TOKEN'
end

api_instance = SyncteraRubySdk::WebhooksApi.new
trigger_event_request = SyncteraRubySdk::TriggerEventRequest.new # TriggerEventRequest | Provide an event type to trigger

begin
  # Trigger an event
  result = api_instance.trigger_event(trigger_event_request)
  p result
rescue SyncteraRubySdk::ApiError => e
  puts "Error when calling WebhooksApi->trigger_event: #{e}"
end

Using the trigger_event_with_http_info variant

This returns an Array which contains the response data, status code and headers.

, Integer, Hash)> trigger_event_with_http_info(trigger_event_request)

begin
  # Trigger an event
  data, status_code, headers = api_instance.trigger_event_with_http_info(trigger_event_request)
  p status_code # => 2xx
  p headers # => { ... }
  p data # => <EventTrigger>
rescue SyncteraRubySdk::ApiError => e
  puts "Error when calling WebhooksApi->trigger_event_with_http_info: #{e}"
end

Parameters

Name	Type	Description	Notes
trigger_event_request	TriggerEventRequest	Provide an event type to trigger

Return type

EventTrigger

Authorization

bearerAuth

HTTP request headers

• Content-Type: application/json
• Accept: application/json, application/problem+json

update_webhook

update_webhook(webhook_id, webhook)

Update a webhook

Update a webhook

Examples

require 'time'
require 'synctera_ruby_sdk'
# setup authorization
SyncteraRubySdk.configure do |config|
  # Configure Bearer authorization (api_key): bearerAuth
  config.access_token = 'YOUR_BEARER_TOKEN'
end

api_instance = SyncteraRubySdk::WebhooksApi.new
webhook_id = 'b01db9c7-78f2-4a99-8aca-1231d32f9b96' # String | Webhook ID
webhook = SyncteraRubySdk::Webhook.new({enabled_events: [SyncteraRubySdk::EventTypeExplicit::ACCOUNT_CREATED], is_enabled: false, url: 'url_example'}) # Webhook | Webhook to update

begin
  # Update a webhook
  result = api_instance.update_webhook(webhook_id, webhook)
  p result
rescue SyncteraRubySdk::ApiError => e
  puts "Error when calling WebhooksApi->update_webhook: #{e}"
end

Using the update_webhook_with_http_info variant

This returns an Array which contains the response data, status code and headers.

, Integer, Hash)> update_webhook_with_http_info(webhook_id, webhook)

begin
  # Update a webhook
  data, status_code, headers = api_instance.update_webhook_with_http_info(webhook_id, webhook)
  p status_code # => 2xx
  p headers # => { ... }
  p data # => <Webhook>
rescue SyncteraRubySdk::ApiError => e
  puts "Error when calling WebhooksApi->update_webhook_with_http_info: #{e}"
end

Parameters

Name	Type	Description	Notes
webhook_id	String	Webhook ID
webhook	Webhook	Webhook to update

Return type

Webhook

Authorization

bearerAuth

HTTP request headers

• Content-Type: application/json
• Accept: application/json, application/problem+json