Skip to content

Mandrill_Webhooks

Mathieu Nayrolles edited this page Jan 20, 2016 · 1 revision

Mandrill_Webhooks

  • Class name: Mandrill_Webhooks
  • Namespace:

Methods

__construct

mixed Mandrill_Webhooks::__construct(\Mandrill $master)
  • Visibility: public

Arguments

getList

array Mandrill_Webhooks::getList()

Get the list of all webhooks defined on the account

  • Visibility: public

add

\struct Mandrill_Webhooks::add(string $url, string $description, array $events)

Add a new webhook

  • Visibility: public

Arguments

  • $url string - <p>the URL to POST batches of events</p>
  • $description string - <p>an optional description of the webhook</p>
  • $events array - <p>an optional list of events that will be posted to the webhook</p> <ul> <li>events[] string the individual event to listen for</li> </ul>

info

\struct Mandrill_Webhooks::info(integer $id)

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

  • Visibility: public

Arguments

  • $id integer - <p>the unique identifier of a webhook belonging to this account</p>

update

\struct Mandrill_Webhooks::update(integer $id, string $url, string $description, array $events)

Update an existing webhook

  • Visibility: public

Arguments

  • $id integer - <p>the unique identifier of a webhook belonging to this account</p>
  • $url string - <p>the URL to POST batches of events</p>
  • $description string - <p>an optional description of the webhook</p>
  • $events array - <p>an optional list of events that will be posted to the webhook</p> <ul> <li>events[] string the individual event to listen for</li> </ul>

delete

\struct Mandrill_Webhooks::delete(integer $id)

Delete an existing webhook

  • Visibility: public

Arguments

  • $id integer - <p>the unique identifier of a webhook belonging to this account</p>
Clone this wiki locally