Class: Sendpost::WebhookApi

Inherits:
Object
  • Object
show all
Defined in:
lib/sendpost_ruby_sdk/api/webhook_api.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ WebhookApi

Returns a new instance of WebhookApi.



19
20
21
 
# File 'lib/sendpost_ruby_sdk/api/webhook_api.rb', line 19

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

Instance Attribute Details

#api_client ⇒ Object

Returns the value of attribute api_client.



17
18
19
 
# File 'lib/sendpost_ruby_sdk/api/webhook_api.rb', line 17

def api_client
  @api_client
end

Instance Method Details

#create_webhook(new_webhook, opts = {}) ⇒ Webhook

Create Webhook Create a new webhook to receive real-time notifications for email events. Your endpoint will receive HTTP POST requests with event data as they occur. Endpoint Requirements: - Must be publicly accessible HTTPS URL - Should return 2xx status within 30 seconds - Handle potential duplicate events (use event ID for deduplication) - Implement retry/queue logic for reliability Choosing Events: - Engagement Tracking: uniqueOpened, uniqueClicked for metrics - Full History: opened, clicked for complete event logs - Delivery Monitoring: delivered, hardBounced, softBounced - Compliance: unsubscribed, spam Best Practices: - Only enable events you actually need - Store events before processing (async processing) - Implement idempotency using event IDs - Set up monitoring for webhook failures Webhook Payload Example: json { \"eventId\": \"evt_123\", \"event\": \"delivered\", \"messageId\": \"msg_456\", \"recipient\": \"[email protected]\", \"timestamp\": \"2024-01-15T10:30:00Z\" }

Parameters:

  • (defaults to: {})

    the optional parameters

Returns:



27
28
29
30
 
# File 'lib/sendpost_ruby_sdk/api/webhook_api.rb', line 27

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

#create_webhook_with_http_info(new_webhook, opts = {}) ⇒ Array<(Webhook, Integer, Hash)>

Create Webhook Create a new webhook to receive real-time notifications for email events. Your endpoint will receive HTTP POST requests with event data as they occur. Endpoint Requirements: - Must be publicly accessible HTTPS URL - Should return 2xx status within 30 seconds - Handle potential duplicate events (use event ID for deduplication) - Implement retry/queue logic for reliability Choosing Events: - Engagement Tracking: `uniqueOpened`, `uniqueClicked` for metrics - Full History: `opened`, `clicked` for complete event logs - Delivery Monitoring: `delivered`, `hardBounced`, `softBounced` - Compliance: `unsubscribed`, `spam` Best Practices: - Only enable events you actually need - Store events before processing (async processing) - Implement idempotency using event IDs - Set up monitoring for webhook failures Webhook Payload Example: ```json { &quot;eventId&quot;: &quot;evt_123&quot;, &quot;event&quot;: &quot;delivered&quot;, &quot;messageId&quot;: &quot;msg_456&quot;, &quot;recipient&quot;: &quot;[email protected]&quot;, &quot;timestamp&quot;: &quot;2024-01-15T10:30:00Z&quot; } ```

Parameters:

  • (defaults to: {})

    the optional parameters

Returns:

  • Webhook data, response status code and response headers



37
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
 
# File 'lib/sendpost_ruby_sdk/api/webhook_api.rb', line 37

def create_webhook_with_http_info(new_webhook, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: WebhookApi.create_webhook ...'
  end
  # verify the required parameter 'new_webhook' is set
  if @api_client.config.client_side_validation && new_webhook.nil?
    fail ArgumentError, "Missing the required parameter 'new_webhook' when calling WebhookApi.create_webhook"
  end
  # resource path
  local_var_path = '/account/webhook'

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

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
  # HTTP header 'Content-Type'
  content_type = @api_client.select_header_content_type(['application/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(new_webhook)

  # return_type
  return_type = opts[:debug_return_type] || 'Webhook'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['accountAuth']

  new_options = opts.merge(
    :operation => :"WebhookApi.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: WebhookApi#create_webhook\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#delete_webhook(webhook_id, opts = {}) ⇒ DeleteWebhookResponse

Delete Webhook Remove a webhook from your account. After deletion, no further events will be sent to that endpoint. Before Deleting: - Ensure your application doesn't rely on these events - Consider updating to a new webhook instead if you're migrating Note: Events that occurred before deletion are not affected. Historical data remains intact.

Parameters:

  • The unique ID of the webhook to delete.

  • (defaults to: {})

    the optional parameters

Returns:



95
96
97
98
 
# File 'lib/sendpost_ruby_sdk/api/webhook_api.rb', line 95

def delete_webhook(webhook_id, opts = {})
  data, _status_code, _headers = delete_webhook_with_http_info(webhook_id, opts)
  data
end

#delete_webhook_with_http_info(webhook_id, opts = {}) ⇒ Array<(DeleteWebhookResponse, Integer, Hash)>

Delete Webhook Remove a webhook from your account. After deletion, no further events will be sent to that endpoint. Before Deleting: - Ensure your application doesn't rely on these events - Consider updating to a new webhook instead if you're migrating Note: Events that occurred before deletion are not affected. Historical data remains intact.

Parameters:

  • The unique ID of the webhook to delete.

  • (defaults to: {})

    the optional parameters

Returns:

  • DeleteWebhookResponse data, response status code and response headers



105
106
107
108
109
110
111
112
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
 
# File 'lib/sendpost_ruby_sdk/api/webhook_api.rb', line 105

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

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

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']

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

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

  # return_type
  return_type = opts[:debug_return_type] || 'DeleteWebhookResponse'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['accountAuth']

  new_options = opts.merge(
    :operation => :"WebhookApi.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: WebhookApi#delete_webhook\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_all_webhooks(opts = {}) ⇒ Array<AccountWebhookWithStats>

List Webhooks Retrieve all configured webhooks for your account. Webhooks enable real-time notifications when email events occur, allowing you to build reactive applications. Supported Events: | Event | Description | |-------|-------------| | processed | Email accepted and queued for delivery | | dropped | Email blocked (suppressed, invalid, policy) | | delivered | Email successfully delivered to recipient | | hardBounced | Permanent delivery failure | | softBounced | Temporary delivery failure | | opened | Recipient opened the email (all opens) | | uniqueOpened | First open per recipient only | | clicked | Recipient clicked a link (all clicks) | | uniqueClicked | First click per recipient only | | unsubscribed | Recipient unsubscribed | | spam | Recipient marked email as spam | Use Cases: - Audit configured webhook endpoints - Verify webhook URLs are correct - Review enabled events per webhook - Debug webhook delivery issues

Parameters:

  • (defaults to: {})

    the optional parameters

Options Hash (opts):

  • :limit (Integer) —

    Number of records to return per request. Default 20. (default to 20)

  • :offset (Integer) —

    Number of initial records to skip for pagination. (default to 0)

  • :search (String) —

    Case insensitive search against webhook URLs.

Returns:



160
161
162
163
 
# File 'lib/sendpost_ruby_sdk/api/webhook_api.rb', line 160

def get_all_webhooks(opts = {})
  data, _status_code, _headers = get_all_webhooks_with_http_info(opts)
  data
end

#get_all_webhooks_with_http_info(opts = {}) ⇒ Array<(Array<AccountWebhookWithStats>, Integer, Hash)>

List Webhooks Retrieve all configured webhooks for your account. Webhooks enable real-time notifications when email events occur, allowing you to build reactive applications. Supported Events: | Event | Description | |-------|-------------| | `processed` | Email accepted and queued for delivery | | `dropped` | Email blocked (suppressed, invalid, policy) | | `delivered` | Email successfully delivered to recipient | | `hardBounced` | Permanent delivery failure | | `softBounced` | Temporary delivery failure | | `opened` | Recipient opened the email (all opens) | | `uniqueOpened` | First open per recipient only | | `clicked` | Recipient clicked a link (all clicks) | | `uniqueClicked` | First click per recipient only | | `unsubscribed` | Recipient unsubscribed | | `spam` | Recipient marked email as spam | Use Cases: - Audit configured webhook endpoints - Verify webhook URLs are correct - Review enabled events per webhook - Debug webhook delivery issues

Parameters:

  • (defaults to: {})

    the optional parameters

Options Hash (opts):

  • :limit (Integer) —

    Number of records to return per request. Default 20. (default to 20)

  • :offset (Integer) —

    Number of initial records to skip for pagination. (default to 0)

  • :search (String) —

    Case insensitive search against webhook URLs.

Returns:

  • Array data, response status code and response headers



172
173
174
175
176
177
178
179
180
181
182
183
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
 
# File 'lib/sendpost_ruby_sdk/api/webhook_api.rb', line 172

def get_all_webhooks_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: WebhookApi.get_all_webhooks ...'
  end
  # resource path
  local_var_path = '/account/webhook'

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'limit'] = opts[:'limit'] if !opts[:'limit'].nil?
  query_params[:'offset'] = opts[:'offset'] if !opts[:'offset'].nil?
  query_params[:'search'] = opts[:'search'] if !opts[:'search'].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']

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

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

  # return_type
  return_type = opts[:debug_return_type] || 'Array<AccountWebhookWithStats>'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['accountAuth']

  new_options = opts.merge(
    :operation => :"WebhookApi.get_all_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: WebhookApi#get_all_webhooks\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_webhook(webhook_id, opts = {}) ⇒ Webhook

Get Webhook Retrieve detailed information about a specific webhook, including its endpoint URL and enabled events. Use Cases: - Verify webhook configuration - Debug event delivery issues - Check enabled events for a webhook - Audit webhook settings

Parameters:

  • The unique ID of the webhook to retrieve.

  • (defaults to: {})

    the optional parameters

Returns:



224
225
226
227
 
# File 'lib/sendpost_ruby_sdk/api/webhook_api.rb', line 224

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

#get_webhook_with_http_info(webhook_id, opts = {}) ⇒ Array<(Webhook, Integer, Hash)>

Get Webhook Retrieve detailed information about a specific webhook, including its endpoint URL and enabled events. Use Cases: - Verify webhook configuration - Debug event delivery issues - Check enabled events for a webhook - Audit webhook settings

Parameters:

  • The unique ID of the webhook to retrieve.

  • (defaults to: {})

    the optional parameters

Returns:

  • Webhook data, response status code and response headers



234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
 
# File 'lib/sendpost_ruby_sdk/api/webhook_api.rb', line 234

def get_webhook_with_http_info(webhook_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: WebhookApi.get_webhook ...'
  end
  # verify the required parameter 'webhook_id' is set
  if @api_client.config.client_side_validation && webhook_id.nil?
    fail ArgumentError, "Missing the required parameter 'webhook_id' when calling WebhookApi.get_webhook"
  end
  # resource path
  local_var_path = '/account/webhook/{webhook_id}'.sub('{' + 'webhook_id' + '}', CGI.escape(webhook_id.to_s))

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

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']

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

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

  # return_type
  return_type = opts[:debug_return_type] || 'Webhook'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['accountAuth']

  new_options = opts.merge(
    :operation => :"WebhookApi.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: WebhookApi#get_webhook\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#update_webhook(update_webhook, webhook_id, opts = {}) ⇒ Webhook

Update Webhook Modify an existing webhook's configuration. Use this to change the endpoint URL or update which events trigger notifications. What Can Be Updated: - Webhook endpoint URL - Enabled/disabled events - Event-specific settings Use Cases: - Migrate to a new endpoint URL - Enable additional events as needs grow - Disable events to reduce traffic - Update after infrastructure changes

Parameters:

  • The unique ID of the webhook to update.

  • (defaults to: {})

    the optional parameters

Returns:



288
289
290
291
 
# File 'lib/sendpost_ruby_sdk/api/webhook_api.rb', line 288

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

#update_webhook_with_http_info(update_webhook, webhook_id, opts = {}) ⇒ Array<(Webhook, Integer, Hash)>

Update Webhook Modify an existing webhook's configuration. Use this to change the endpoint URL or update which events trigger notifications. What Can Be Updated: - Webhook endpoint URL - Enabled/disabled events - Event-specific settings Use Cases: - Migrate to a new endpoint URL - Enable additional events as needs grow - Disable events to reduce traffic - Update after infrastructure changes

Parameters:

  • The unique ID of the webhook to update.

  • (defaults to: {})

    the optional parameters

Returns:

  • Webhook data, response status code and response headers



299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
 
# File 'lib/sendpost_ruby_sdk/api/webhook_api.rb', line 299

def update_webhook_with_http_info(update_webhook, webhook_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: WebhookApi.update_webhook ...'
  end
  # verify the required parameter 'update_webhook' is set
  if @api_client.config.client_side_validation && update_webhook.nil?
    fail ArgumentError, "Missing the required parameter 'update_webhook' when calling WebhookApi.update_webhook"
  end
  # verify the required parameter 'webhook_id' is set
  if @api_client.config.client_side_validation && webhook_id.nil?
    fail ArgumentError, "Missing the required parameter 'webhook_id' when calling WebhookApi.update_webhook"
  end
  # resource path
  local_var_path = '/account/webhook/{webhook_id}'.sub('{' + 'webhook_id' + '}', CGI.escape(webhook_id.to_s))

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

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
  # HTTP header 'Content-Type'
  content_type = @api_client.select_header_content_type(['application/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(update_webhook)

  # return_type
  return_type = opts[:debug_return_type] || 'Webhook'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['accountAuth']

  new_options = opts.merge(
    :operation => :"WebhookApi.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(:PUT, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: WebhookApi#update_webhook\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end