Class: KlaviyoAPI::WebhooksApi

Inherits:
Object
  • Object
show all
Defined in:
lib/klaviyo-api-sdk/api/webhooks_api.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ WebhooksApi

Returns a new instance of WebhooksApi.



18
19
20
 
# File 'lib/klaviyo-api-sdk/api/webhooks_api.rb', line 18

def initialize(api_client = ApiClient.default)
  @api_client = api_client
end

Instance Attribute Details

#api_client ⇒ Object

Returns the value of attribute api_client.



16
17
18
 
# File 'lib/klaviyo-api-sdk/api/webhooks_api.rb', line 16

def api_client
  @api_client
end

Instance Method Details

#create_webhook(webhook_create_query, opts = {}) ⇒ Hash<String, Object>

Create Webhook Create a new Webhook

Rate limits:
Burst: 1/s<br>Steady: 15/m Scopes: webhooks:write OpenAPI Spec

Parameters:

  • webhook_create_query (WebhookCreateQuery)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

Returns:

  • (Hash<String, Object>) 


27
28
29
30
 
# File 'lib/klaviyo-api-sdk/api/webhooks_api.rb', line 27

def create_webhook(webhook_create_query, opts = {})
  data, _status_code, _headers = create_webhook_with_http_info(webhook_create_query, opts)
  data
end

#create_webhook_with_http_info(webhook_create_query, opts = {}) ⇒ Array<(Hash<String, Object>, Integer, Hash)>

Create Webhook Create a new Webhook<br><br>Rate limits:<br>Burst: `1/s`<br>Steady: `15/m` Scopes: `webhooks:write` OpenAPI Spec

Parameters:

  • webhook_create_query (WebhookCreateQuery)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

Returns:

  • (Array<(Hash<String, Object>, Integer, Hash)>) —

    Hash<String, Object> data, response status code and response headers



38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
 
# File 'lib/klaviyo-api-sdk/api/webhooks_api.rb', line 38

def create_webhook_with_http_info(webhook_create_query, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: WebhooksApi.create_webhook ...'
  end
  # verify the required parameter 'webhook_create_query' is set
  if @api_client.config.client_side_validation && webhook_create_query.nil?
    fail ArgumentError, "Missing the required parameter 'webhook_create_query' when calling WebhooksApi.create_webhook"
  end
  allowable_values = ["created_at", "description", "enabled", "endpoint_url", "id", "name", "updated_at"]
  if @api_client.config.client_side_validation && opts[:'fields_webhook'] && !opts[:'fields_webhook'].all? { |item| allowable_values.include?(item) }
    fail ArgumentError, "invalid value for \"fields_webhook\", must include one of #{allowable_values}"
  end
  # resource path
  local_var_path = '/api/webhooks'

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'fields[webhook]'] = @api_client.build_collection_param(opts[:'fields_webhook'], :csv) if !opts[:'fields_webhook'].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  # klaviyo api revision
  header_params['revision'] =  ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2026-07-15"
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/vnd.api+json'])
  # HTTP header 'Content-Type'
  content_type = @api_client.select_header_content_type(['application/vnd.api+json'])
  if !content_type.nil?
      header_params['Content-Type'] = content_type
  end

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body] || @api_client.object_to_http_body(webhook_create_query)

  # return_type
  return_type = opts[:debug_return_type] || 'Hash<String, Object>'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['Klaviyo-API-Key', 'OAuth']

  new_options = opts.merge(
    :operation => :"WebhooksApi.create_webhook",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: WebhooksApi#create_webhook\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#delete_webhook(id, opts = {}) ⇒ nil

Delete Webhook Delete a webhook with the given ID.

Rate limits:
Burst: 1/s<br>Steady: 15/m Scopes: webhooks:write OpenAPI Spec

Parameters:

  • id (String) —

    The ID of the webhook.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (nil) 


103
104
105
106
 
# File 'lib/klaviyo-api-sdk/api/webhooks_api.rb', line 103

def delete_webhook(id, opts = {})
  delete_webhook_with_http_info(id, opts)
  nil
end

#delete_webhook_with_http_info(id, opts = {}) ⇒ Array<(nil, Integer, Hash)>

Delete Webhook Delete a webhook with the given ID.<br><br>Rate limits:<br>Burst: `1/s`<br>Steady: `15/m` Scopes: `webhooks:write` OpenAPI Spec

Parameters:

  • id (String) —

    The ID of the webhook.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(nil, Integer, Hash)>) —

    nil, response status code and response headers



113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
 
# File 'lib/klaviyo-api-sdk/api/webhooks_api.rb', line 113

def delete_webhook_with_http_info(id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: WebhooksApi.delete_webhook ...'
  end
  # verify the required parameter 'id' is set
  if @api_client.config.client_side_validation && id.nil?
    fail ArgumentError, "Missing the required parameter 'id' when calling WebhooksApi.delete_webhook"
  end
  # resource path
  local_var_path = '/api/webhooks/{id}'.sub('{' + 'id' + '}', CGI.escape(id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # klaviyo api revision
  header_params['revision'] =  ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2026-07-15"
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/vnd.api+json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type]

  # auth_names
  auth_names = opts[:debug_auth_names] || ['Klaviyo-API-Key', 'OAuth']

  new_options = opts.merge(
    :operation => :"WebhooksApi.delete_webhook",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:DELETE, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: WebhooksApi#delete_webhook\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_webhook(id, opts = {}) ⇒ Hash<String, Object>

Get Webhook Get the webhook with the given ID.

Rate limits:
Burst: 1/s<br>Steady: 15/m Scopes: webhooks:read OpenAPI Spec

Parameters:

  • id (String) —

    The ID of the webhook.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

Returns:

  • (Hash<String, Object>) 


171
172
173
174
 
# File 'lib/klaviyo-api-sdk/api/webhooks_api.rb', line 171

def get_webhook(id, opts = {})
  data, _status_code, _headers = get_webhook_with_http_info(id, opts)
  data
end

#get_webhook_topic(id, opts = {}) ⇒ Hash<String, Object>

Get Webhook Topic Get the webhook topic with the given ID.

Rate limits:
Burst: 1/s<br>Steady: 15/m Scopes: webhooks:read OpenAPI Spec

Parameters:

  • id (String) —

    The ID of the webhook topic.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

Returns:

  • (Hash<String, Object>) 


255
256
257
258
 
# File 'lib/klaviyo-api-sdk/api/webhooks_api.rb', line 255

def get_webhook_topic(id, opts = {})
  data, _status_code, _headers = get_webhook_topic_with_http_info(id, opts)
  data
end

#get_webhook_topic_with_http_info(id, opts = {}) ⇒ Array<(Hash<String, Object>, Integer, Hash)>

Get Webhook Topic Get the webhook topic with the given ID.<br><br>Rate limits:<br>Burst: `1/s`<br>Steady: `15/m` Scopes: `webhooks:read` OpenAPI Spec

Parameters:

  • id (String) —

    The ID of the webhook topic.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

Returns:

  • (Array<(Hash<String, Object>, Integer, Hash)>) —

    Hash<String, Object> data, response status code and response headers



266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
 
# File 'lib/klaviyo-api-sdk/api/webhooks_api.rb', line 266

def get_webhook_topic_with_http_info(id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: WebhooksApi.get_webhook_topic ...'
  end
  # verify the required parameter 'id' is set
  if @api_client.config.client_side_validation && id.nil?
    fail ArgumentError, "Missing the required parameter 'id' when calling WebhooksApi.get_webhook_topic"
  end
  allowable_values = ["id"]
  if @api_client.config.client_side_validation && opts[:'fields_webhook_topic'] && !opts[:'fields_webhook_topic'].all? { |item| allowable_values.include?(item) }
    fail ArgumentError, "invalid value for \"fields_webhook_topic\", must include one of #{allowable_values}"
  end
  # resource path
  local_var_path = '/api/webhook-topics/{id}'.sub('{' + 'id' + '}', CGI.escape(id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'fields[webhook-topic]'] = @api_client.build_collection_param(opts[:'fields_webhook_topic'], :csv) if !opts[:'fields_webhook_topic'].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  # klaviyo api revision
  header_params['revision'] =  ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2026-07-15"
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/vnd.api+json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'Hash<String, Object>'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['Klaviyo-API-Key', 'OAuth']

  new_options = opts.merge(
    :operation => :"WebhooksApi.get_webhook_topic",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: WebhooksApi#get_webhook_topic\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_webhook_topics(opts = {}) ⇒ Hash<String, Object>

Get Webhook Topics Get all webhook topics in a Klaviyo account.

Rate limits:
Burst: 1/s<br>Steady: 15/m Scopes: webhooks:read OpenAPI Spec

Parameters:

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

Returns:

  • (Hash<String, Object>) 


326
327
328
329
 
# File 'lib/klaviyo-api-sdk/api/webhooks_api.rb', line 326

def get_webhook_topics(opts = {})
  data, _status_code, _headers = get_webhook_topics_with_http_info(opts)
  data
end

#get_webhook_topics_with_http_info(opts = {}) ⇒ Array<(Hash<String, Object>, Integer, Hash)>

Get Webhook Topics Get all webhook topics in a Klaviyo account.<br><br>Rate limits:<br>Burst: `1/s`<br>Steady: `15/m` Scopes: `webhooks:read` OpenAPI Spec

Parameters:

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

Returns:

  • (Array<(Hash<String, Object>, Integer, Hash)>) —

    Hash<String, Object> data, response status code and response headers



336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
 
# File 'lib/klaviyo-api-sdk/api/webhooks_api.rb', line 336

def get_webhook_topics_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: WebhooksApi.get_webhook_topics ...'
  end
  allowable_values = ["id"]
  if @api_client.config.client_side_validation && opts[:'fields_webhook_topic'] && !opts[:'fields_webhook_topic'].all? { |item| allowable_values.include?(item) }
    fail ArgumentError, "invalid value for \"fields_webhook_topic\", must include one of #{allowable_values}"
  end
  # resource path
  local_var_path = '/api/webhook-topics'

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'fields[webhook-topic]'] = @api_client.build_collection_param(opts[:'fields_webhook_topic'], :csv) if !opts[:'fields_webhook_topic'].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  # klaviyo api revision
  header_params['revision'] =  ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2026-07-15"
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/vnd.api+json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'Hash<String, Object>'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['Klaviyo-API-Key', 'OAuth']

  new_options = opts.merge(
    :operation => :"WebhooksApi.get_webhook_topics",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: WebhooksApi#get_webhook_topics\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_webhook_with_http_info(id, opts = {}) ⇒ Array<(Hash<String, Object>, Integer, Hash)>

Get Webhook Get the webhook with the given ID.<br><br>Rate limits:<br>Burst: `1/s`<br>Steady: `15/m` Scopes: `webhooks:read` OpenAPI Spec

Parameters:

  • id (String) —

    The ID of the webhook.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

Returns:

  • (Array<(Hash<String, Object>, Integer, Hash)>) —

    Hash<String, Object> data, response status code and response headers



184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
 
# File 'lib/klaviyo-api-sdk/api/webhooks_api.rb', line 184

def get_webhook_with_http_info(id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: WebhooksApi.get_webhook ...'
  end
  # verify the required parameter 'id' is set
  if @api_client.config.client_side_validation && id.nil?
    fail ArgumentError, "Missing the required parameter 'id' when calling WebhooksApi.get_webhook"
  end
  allowable_values = ["id"]
  if @api_client.config.client_side_validation && opts[:'fields_webhook_topic'] && !opts[:'fields_webhook_topic'].all? { |item| allowable_values.include?(item) }
    fail ArgumentError, "invalid value for \"fields_webhook_topic\", must include one of #{allowable_values}"
  end
  allowable_values = ["created_at", "description", "enabled", "endpoint_url", "id", "name", "updated_at"]
  if @api_client.config.client_side_validation && opts[:'fields_webhook'] && !opts[:'fields_webhook'].all? { |item| allowable_values.include?(item) }
    fail ArgumentError, "invalid value for \"fields_webhook\", must include one of #{allowable_values}"
  end
  allowable_values = ["webhook-topics"]
  if @api_client.config.client_side_validation && opts[:'include'] && !opts[:'include'].all? { |item| allowable_values.include?(item) }
    fail ArgumentError, "invalid value for \"include\", must include one of #{allowable_values}"
  end
  # resource path
  local_var_path = '/api/webhooks/{id}'.sub('{' + 'id' + '}', CGI.escape(id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'fields[webhook-topic]'] = @api_client.build_collection_param(opts[:'fields_webhook_topic'], :csv) if !opts[:'fields_webhook_topic'].nil?
  query_params[:'fields[webhook]'] = @api_client.build_collection_param(opts[:'fields_webhook'], :csv) if !opts[:'fields_webhook'].nil?
  query_params[:'include'] = @api_client.build_collection_param(opts[:'include'], :csv) if !opts[:'include'].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  # klaviyo api revision
  header_params['revision'] =  ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2026-07-15"
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/vnd.api+json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'Hash<String, Object>'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['Klaviyo-API-Key', 'OAuth']

  new_options = opts.merge(
    :operation => :"WebhooksApi.get_webhook",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: WebhooksApi#get_webhook\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_webhooks(opts = {}) ⇒ Hash<String, Object>

Get Webhooks Get all webhooks in an account.

Rate limits:
Burst: 1/s<br>Steady: 15/m Scopes: webhooks:read OpenAPI Spec

Parameters:

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

Returns:

  • (Hash<String, Object>) 


394
395
396
397
 
# File 'lib/klaviyo-api-sdk/api/webhooks_api.rb', line 394

def get_webhooks(opts = {})
  data, _status_code, _headers = get_webhooks_with_http_info(opts)
  data
end

#get_webhooks_with_http_info(opts = {}) ⇒ Array<(Hash<String, Object>, Integer, Hash)>

Get Webhooks Get all webhooks in an account.<br><br>Rate limits:<br>Burst: `1/s`<br>Steady: `15/m` Scopes: `webhooks:read` OpenAPI Spec

Parameters:

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

Returns:

  • (Array<(Hash<String, Object>, Integer, Hash)>) —

    Hash<String, Object> data, response status code and response headers



406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
 
# File 'lib/klaviyo-api-sdk/api/webhooks_api.rb', line 406

def get_webhooks_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: WebhooksApi.get_webhooks ...'
  end
  allowable_values = ["id"]
  if @api_client.config.client_side_validation && opts[:'fields_webhook_topic'] && !opts[:'fields_webhook_topic'].all? { |item| allowable_values.include?(item) }
    fail ArgumentError, "invalid value for \"fields_webhook_topic\", must include one of #{allowable_values}"
  end
  allowable_values = ["created_at", "description", "enabled", "endpoint_url", "id", "name", "updated_at"]
  if @api_client.config.client_side_validation && opts[:'fields_webhook'] && !opts[:'fields_webhook'].all? { |item| allowable_values.include?(item) }
    fail ArgumentError, "invalid value for \"fields_webhook\", must include one of #{allowable_values}"
  end
  allowable_values = ["webhook-topics"]
  if @api_client.config.client_side_validation && opts[:'include'] && !opts[:'include'].all? { |item| allowable_values.include?(item) }
    fail ArgumentError, "invalid value for \"include\", must include one of #{allowable_values}"
  end
  # resource path
  local_var_path = '/api/webhooks'

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'fields[webhook-topic]'] = @api_client.build_collection_param(opts[:'fields_webhook_topic'], :csv) if !opts[:'fields_webhook_topic'].nil?
  query_params[:'fields[webhook]'] = @api_client.build_collection_param(opts[:'fields_webhook'], :csv) if !opts[:'fields_webhook'].nil?
  query_params[:'include'] = @api_client.build_collection_param(opts[:'include'], :csv) if !opts[:'include'].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  # klaviyo api revision
  header_params['revision'] =  ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2026-07-15"
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/vnd.api+json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'Hash<String, Object>'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['Klaviyo-API-Key', 'OAuth']

  new_options = opts.merge(
    :operation => :"WebhooksApi.get_webhooks",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: WebhooksApi#get_webhooks\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#update_webhook(id, webhook_partial_update_query, opts = {}) ⇒ Hash<String, Object>

Update Webhook Update the webhook with the given ID.

Rate limits:
Burst: 1/s<br>Steady: 15/m Scopes: webhooks:write OpenAPI Spec

Parameters:

  • id (String) —

    The ID of the webhook.

  • webhook_partial_update_query (WebhookPartialUpdateQuery)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

Returns:

  • (Hash<String, Object>) 


474
475
476
477
 
# File 'lib/klaviyo-api-sdk/api/webhooks_api.rb', line 474

def update_webhook(id, webhook_partial_update_query, opts = {})
  data, _status_code, _headers = update_webhook_with_http_info(id, webhook_partial_update_query, opts)
  data
end

#update_webhook_with_http_info(id, webhook_partial_update_query, opts = {}) ⇒ Array<(Hash<String, Object>, Integer, Hash)>

Update Webhook Update the webhook with the given ID.<br><br>Rate limits:<br>Burst: `1/s`<br>Steady: `15/m` Scopes: `webhooks:write` OpenAPI Spec

Parameters:

  • id (String) —

    The ID of the webhook.

  • webhook_partial_update_query (WebhookPartialUpdateQuery)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

Returns:

  • (Array<(Hash<String, Object>, Integer, Hash)>) —

    Hash<String, Object> data, response status code and response headers



486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
 
# File 'lib/klaviyo-api-sdk/api/webhooks_api.rb', line 486

def update_webhook_with_http_info(id, webhook_partial_update_query, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: WebhooksApi.update_webhook ...'
  end
  # verify the required parameter 'id' is set
  if @api_client.config.client_side_validation && id.nil?
    fail ArgumentError, "Missing the required parameter 'id' when calling WebhooksApi.update_webhook"
  end
  # verify the required parameter 'webhook_partial_update_query' is set
  if @api_client.config.client_side_validation && webhook_partial_update_query.nil?
    fail ArgumentError, "Missing the required parameter 'webhook_partial_update_query' when calling WebhooksApi.update_webhook"
  end
  allowable_values = ["created_at", "description", "enabled", "endpoint_url", "id", "name", "updated_at"]
  if @api_client.config.client_side_validation && opts[:'fields_webhook'] && !opts[:'fields_webhook'].all? { |item| allowable_values.include?(item) }
    fail ArgumentError, "invalid value for \"fields_webhook\", must include one of #{allowable_values}"
  end
  # resource path
  local_var_path = '/api/webhooks/{id}'.sub('{' + 'id' + '}', CGI.escape(id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'fields[webhook]'] = @api_client.build_collection_param(opts[:'fields_webhook'], :csv) if !opts[:'fields_webhook'].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  # klaviyo api revision
  header_params['revision'] =  ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2026-07-15"
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/vnd.api+json'])
  # HTTP header 'Content-Type'
  content_type = @api_client.select_header_content_type(['application/vnd.api+json'])
  if !content_type.nil?
      header_params['Content-Type'] = content_type
  end

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body] || @api_client.object_to_http_body(webhook_partial_update_query)

  # return_type
  return_type = opts[:debug_return_type] || 'Hash<String, Object>'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['Klaviyo-API-Key', 'OAuth']

  new_options = opts.merge(
    :operation => :"WebhooksApi.update_webhook",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:PATCH, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: WebhooksApi#update_webhook\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end