Class: Wavefront::Webhook

Inherits:
CoreApi
  • Object
show all
Defined in:
lib/wavefront-sdk/webhook.rb

Overview

Manage and query Wavefront webhooks

Instance Attribute Summary

Attributes inherited from CoreApi

#api, #creds, #logger, #opts

Instance Method Summary collapse

Methods inherited from CoreApi

#api_base, #api_path, #hash_for_update, #initialize, #setup_api, #time_to_ms

Methods included from Mixins

#log, #parse_relative_time, #parse_time, #relative_time, #time_multiplier, #valid_relative_time?

Methods included from Validators

#uuid?, #wf_account_id?, #wf_alert_id?, #wf_alert_severity?, #wf_apitoken_id?, #wf_aws_external_id?, #wf_cloudintegration_id?, #wf_dashboard_id?, #wf_derivedmetric_id?, #wf_distribution?, #wf_distribution_count?, #wf_distribution_interval?, #wf_distribution_values?, #wf_epoch?, #wf_event_id?, #wf_granularity?, #wf_ingestionpolicy_id?, #wf_integration_id?, #wf_link_id?, #wf_link_template?, #wf_maintenance_window_id?, #wf_message_id?, #wf_metric_name?, #wf_metricspolicy_id?, #wf_monitoredcluster_id?, #wf_ms_ts?, #wf_name?, #wf_notificant_id?, #wf_permission?, #wf_point?, #wf_point_tag?, #wf_point_tags?, #wf_proxy_id?, #wf_role_id?, #wf_sampling_value?, #wf_savedsearch_entity?, #wf_savedsearch_id?, #wf_serviceaccount_id?, #wf_source_id?, #wf_string?, #wf_tag?, #wf_trace?, #wf_ts?, #wf_user_id?, #wf_usergroup_id?, #wf_value?, #wf_version?, #wf_webhook_id?

Constructor Details

This class inherits a constructor from Wavefront::CoreApi

Instance Method Details

#create(body) ⇒ Wavefront::Response

POST /api/v2/webhook Create a specific webhook.

Parameters:

  • body (Hash) —

    a hash of parameters describing the webhook. Please refer to the Wavefront Swagger docs for key:value information

Returns:

Raises:

  • (ArgumentError) 


32
33
34
35
36
 
# File 'lib/wavefront-sdk/webhook.rb', line 32

def create(body)
  raise ArgumentError unless body.is_a?(Hash)

  api.post('', body, 'application/json')
end

#delete(id) ⇒ Wavefront::Response

DELETE /api/v2/webhook/id Delete a specific webhook.

Parameters:

  • id (String, Integer) —

    ID of the webhook

Returns:



44
45
46
47
 
# File 'lib/wavefront-sdk/webhook.rb', line 44

def delete(id)
  wf_webhook_id?(id)
  api.delete(id)
end

#describe(id) ⇒ Wavefront::Response

GET /api/v2/webhook/id Get a specific webhook.

Parameters:

  • id (String, Integer) —

    ID of the webhook

Returns:



55
56
57
58
 
# File 'lib/wavefront-sdk/webhook.rb', line 55

def describe(id)
  wf_webhook_id?(id)
  api.get(id)
end

#list(offset = 0, limit = 100) ⇒ Object

GET /api/v2/webhook Get all webhooks for a customer.

Parameters:

  • offset (Integer) (defaults to: 0) —

    webhook at which the list begins

  • limit (Integer) (defaults to: 100) —

    the number of webhooks to return



20
21
22
 
# File 'lib/wavefront-sdk/webhook.rb', line 20

def list(offset = 0, limit = 100)
  api.get('', offset: offset, limit: limit)
end

#update(id, body, modify = true) ⇒ Wavefront::Response

PUT /api/v2/webhook/id Update a specific webhook.

Parameters:

  • id (String) —

    a Wavefront webhook ID

  • body (Hash) —

    key-value hash of the parameters you wish to change

  • modify (true, false) (defaults to: true) —

    if true, use #describe() to get a hash describing the existing object, and modify that with the new body. If false, pass the new body straight through.

Returns:

Raises:

  • (ArgumentError) 


71
72
73
74
75
76
77
78
79
 
# File 'lib/wavefront-sdk/webhook.rb', line 71

def update(id, body, modify = true)
  wf_webhook_id?(id)
  raise ArgumentError unless body.is_a?(Hash)

  return api.put(id, body, 'application/json') unless modify

  api.put(id, hash_for_update(describe(id).response, body),
          'application/json')
end

#update_keys ⇒ Object 



10
11
12
 
# File 'lib/wavefront-sdk/webhook.rb', line 10

def update_keys
  %i[id title description template title triggers recipient]
end