Class: Mandrill::Webhooks

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

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(master) ⇒ Webhooks

Returns a new instance of Webhooks.



1045
1046
1047
 
# File 'lib/mandrill/api.rb', line 1045

def initialize(master)
    @master = master
end

Instance Attribute Details

#master ⇒ Object

Returns the value of attribute master.



1043
1044
1045
 
# File 'lib/mandrill/api.rb', line 1043

def master
  @master
end

Instance Method Details

#add(url, description = nil, events = []) ⇒ Hash

Add a new webhook

Parameters:

  • url (String) —

    the URL to POST batches of events

  • description (String) (defaults to: nil) —

    an optional description of the webhook

  • events (Array) (defaults to: []) —

    an optional list of events that will be posted to the webhook

    • String

      events[] the individual event to listen for

Returns:

  • (Hash) —

    the information saved about the new webhook

    • Integer

      id a unique integer indentifier for the webhook

    • String

      url The URL that the event data will be posted to

    • String

      description a description of the webhook

    • String

      auth_key the key used to requests for this webhook

    • Array

      events The message events that will be posted to the hook

      - [String] events[] the individual message event (send, hard_bounce, soft_bounce, open, click, spam, unsub, or reject)
    • String

      created_at the date and time that the webhook was created as a UTC string in YYYY-MM-DD HH:MM:SS format

    • String

      last_sent_at the date and time that the webhook last successfully received events as a UTC string in YYYY-MM-DD HH:MM:SS format

    • Integer

      batches_sent the number of event batches that have ever been sent to this webhook

    • Integer

      events_sent the total number of events that have ever been sent to this webhook

    • String

      last_error if we’ve ever gotten an error trying to post to this webhook, the last error that we’ve seen



1085
1086
1087
1088
 
# File 'lib/mandrill/api.rb', line 1085

def add(url, description=nil, events=[])
    _params = {:url => url, :description => description, :events => events}
    return @master.call 'webhooks/add', _params
end

#delete(id) ⇒ Hash

Delete an existing webhook

Parameters:

  • id (Integer) —

    the unique identifier of a webhook belonging to this account

Returns:

  • (Hash) —

    the information for the deleted webhook

    • Integer

      id a unique integer indentifier for the webhook

    • String

      url The URL that the event data will be posted to

    • String

      description a description of the webhook

    • String

      auth_key the key used to requests for this webhook

    • Array

      events The message events that will be posted to the hook

      - [String] events[] the individual message event (send, hard_bounce, soft_bounce, open, click, spam, unsub, or reject)
    • String

      created_at the date and time that the webhook was created as a UTC string in YYYY-MM-DD HH:MM:SS format

    • String

      last_sent_at the date and time that the webhook last successfully received events as a UTC string in YYYY-MM-DD HH:MM:SS format

    • Integer

      batches_sent the number of event batches that have ever been sent to this webhook

    • Integer

      events_sent the total number of events that have ever been sent to this webhook

    • String

      last_error if we’ve ever gotten an error trying to post to this webhook, the last error that we’ve seen



1146
1147
1148
1149
 
# File 'lib/mandrill/api.rb', line 1146

def delete(id)
    _params = {:id => id}
    return @master.call 'webhooks/delete', _params
end

#info(id) ⇒ Hash

Given the ID of an existing webhook, return the data about it

Parameters:

  • id (Integer) —

    the unique identifier of a webhook belonging to this account

Returns:

  • (Hash) —

    the information about the webhook

    • Integer

      id a unique integer indentifier for the webhook

    • String

      url The URL that the event data will be posted to

    • String

      description a description of the webhook

    • String

      auth_key the key used to requests for this webhook

    • Array

      events The message events that will be posted to the hook

      - [String] events[] the individual message event (send, hard_bounce, soft_bounce, open, click, spam, unsub, or reject)
    • String

      created_at the date and time that the webhook was created as a UTC string in YYYY-MM-DD HH:MM:SS format

    • String

      last_sent_at the date and time that the webhook last successfully received events as a UTC string in YYYY-MM-DD HH:MM:SS format

    • Integer

      batches_sent the number of event batches that have ever been sent to this webhook

    • Integer

      events_sent the total number of events that have ever been sent to this webhook

    • String

      last_error if we’ve ever gotten an error trying to post to this webhook, the last error that we’ve seen



1104
1105
1106
1107
 
# File 'lib/mandrill/api.rb', line 1104

def info(id)
    _params = {:id => id}
    return @master.call 'webhooks/info', _params
end

#list ⇒ Array

Get the list of all webhooks defined on the account

Returns:

  • (Array) —

    the webhooks associated with the account

    • Hash

      return[] the individual webhook info

      - [Integer] id a unique integer indentifier for the webhook
- [String] url The URL that the event data will be posted to
- [String] description a description of the webhook
- [String] auth_key the key used to requests for this webhook
- [Array] events The message events that will be posted to the hook
    - [String] events[] the individual message event (send, hard_bounce, soft_bounce, open, click, spam, unsub, or reject)
- [String] created_at the date and time that the webhook was created as a UTC string in YYYY-MM-DD HH:MM:SS format
- [String] last_sent_at the date and time that the webhook last successfully received events as a UTC string in YYYY-MM-DD HH:MM:SS format
- [Integer] batches_sent the number of event batches that have ever been sent to this webhook
- [Integer] events_sent the total number of events that have ever been sent to this webhook
- [String] last_error if we've ever gotten an error trying to post to this webhook, the last error that we've seen



1063
1064
1065
1066
 
# File 'lib/mandrill/api.rb', line 1063

def list()
    _params = {}
    return @master.call 'webhooks/list', _params
end

#update(id, url, description = nil, events = []) ⇒ Hash

Update an existing webhook

Parameters:

  • id (Integer) —

    the unique identifier of a webhook belonging to this account

  • url (String) —

    the URL to POST batches of events

  • description (String) (defaults to: nil) —

    an optional description of the webhook

  • events (Array) (defaults to: []) —

    an optional list of events that will be posted to the webhook

    • String

      events[] the individual event to listen for

Returns:

  • (Hash) —

    the information for the updated webhook

    • Integer

      id a unique integer indentifier for the webhook

    • String

      url The URL that the event data will be posted to

    • String

      description a description of the webhook

    • String

      auth_key the key used to requests for this webhook

    • Array

      events The message events that will be posted to the hook

      - [String] events[] the individual message event (send, hard_bounce, soft_bounce, open, click, spam, unsub, or reject)
    • String

      created_at the date and time that the webhook was created as a UTC string in YYYY-MM-DD HH:MM:SS format

    • String

      last_sent_at the date and time that the webhook last successfully received events as a UTC string in YYYY-MM-DD HH:MM:SS format

    • Integer

      batches_sent the number of event batches that have ever been sent to this webhook

    • Integer

      events_sent the total number of events that have ever been sent to this webhook

    • String

      last_error if we’ve ever gotten an error trying to post to this webhook, the last error that we’ve seen



1127
1128
1129
1130
 
# File 'lib/mandrill/api.rb', line 1127

def update(id, url, description=nil, events=[])
    _params = {:id => id, :url => url, :description => description, :events => events}
    return @master.call 'webhooks/update', _params
end