Class: Mailtrap::WebhooksAPI

Inherits:
Object
  • Object
show all
Includes:
BaseAPI
Defined in:
lib/mailtrap/webhooks_api.rb

Instance Attribute Summary

Attributes included from BaseAPI

#account_id, #client

Instance Method Summary collapse

Methods included from BaseAPI

included, #initialize

Instance Method Details

#create(options) ⇒ Webhook

Creates a new webhook

Parameters:

  • options (Hash) —

    The parameters to create

Options Hash (options):

  • :url (String) —

    The URL that will receive webhook payloads

  • :webhook_type (String) —

    The type of webhook (email_sending, campaigns, audit_log or inbound_receiving)

  • :active (Boolean) —

    Whether the webhook is active. Defaults to true.

  • :payload_format (String) —

    Payload format (json or jsonlines). Defaults to json.

  • :sending_stream (String) —

    Sending stream (transactional or bulk). Required for email_sending webhook type.

  • :event_types (Array<String>) —

    Event types to subscribe to. Required for email_sending webhook type.

  • :domain_id (Integer) —

    Sending domain ID to scope the webhook to. Applicable only for email_sending webhooks.

  • :inbound_inbox_id (Integer) —

    Inbound inbox ID to link the webhook to. Applicable only for inbound_receiving webhooks; omit to apply to all inboxes in the account.

Returns:

  • (Webhook) —

    Created webhook (includes signing_secret)

Raises:



50
51
52
 
# File 'lib/mailtrap/webhooks_api.rb', line 50

def create(options)
  base_create(options)
end

#delete(webhook_id) ⇒ Webhook

Deletes a webhook

Parameters:

  • webhook_id (Integer) —

    The webhook ID

Returns:

Raises:



75
76
77
78
 
# File 'lib/mailtrap/webhooks_api.rb', line 75

def delete(webhook_id)
  response = client.delete("#{base_path}/#{webhook_id}")
  handle_response(response) if response
end

#get(webhook_id) ⇒ Webhook

Retrieves a specific webhook

Parameters:

  • webhook_id (Integer) —

    The webhook ID

Returns:

Raises:



27
28
29
 
# File 'lib/mailtrap/webhooks_api.rb', line 27

def get(webhook_id)
  base_get(webhook_id)
end

#list ⇒ Array<Webhook>

Lists all webhooks for the account

Returns:

  • (Array<Webhook>) —

    Array of webhooks

Raises:



18
19
20
21
 
# File 'lib/mailtrap/webhooks_api.rb', line 18

def list
  response = client.get(base_path)
  response[:data].map { |item| build_entity(item, response_class) }
end

#update(webhook_id, options) ⇒ Webhook

Updates an existing webhook

Parameters:

  • webhook_id (Integer) —

    The webhook ID

  • options (Hash) —

    The parameters to update

Options Hash (options):

  • :url (String) —

    The URL that will receive webhook payloads

  • :active (Boolean) —

    Whether the webhook is active

  • :payload_format (String) —

    Payload format (json or jsonlines)

  • :event_types (Array<String>) —

    Event types to subscribe to. Applicable only for email_sending webhooks.

  • :inbound_inbox_id (Integer) —

    Inbound inbox ID to link the webhook to. Applicable only for inbound_receiving webhooks.

Returns:

Raises:



67
68
69
 
# File 'lib/mailtrap/webhooks_api.rb', line 67

def update(webhook_id, options)
  base_update(webhook_id, options, %i[url active payload_format event_types inbound_inbox_id])
end