Overview
  • Namespace
  • Class

Namespaces

  • MailChimp
    • AuthorizedApps
    • Automations
    • Batches
    • CampaignFolders
    • Campaigns
    • Conversations
    • Ecommerce
    • FileManager
    • Lists
    • Reports
    • TemplateFolders
    • Templates

Classes

  • Interests
  • Lists
  • Members
  • MergeFields
  • Segments
  • SignupForms
  • Webhooks

Class Webhooks

MailChimp\MailChimp
Extended by MailChimp\Lists\Lists
Extended by MailChimp\Lists\Webhooks
Namespace: MailChimp\Lists
Located at Lists/Webhooks.php

Methods summary

public object
# getWebhooks( string $list_id, array $query = [] )

Get a list of webhooks

Get a list of webhooks

Parameters

$list_id
$query
(See Above) OPTIONAL associative array of query parameters.

Returns

object
public object
# getWebhook( string $list_id, string $webhook_id, array $query = [] )

Get a single webhook

Get a single webhook

Parameters

$list_id
$webhook_id
$query
(See Above) OPTIONAL associative array of query parameters.

Returns

object
public object
# createWebhook( string $list_id, array $data = [] )

Create a new webhook

Create a new webhook

array["data"] ["url"] string A valid URL for the Webhook. ["events"] array The events that can trigger the webhook and whether they are enabled. "subscribe" boolean "unsubscribe" boolean "profile" boolean "cleaned" boolean "upemail" boolean "campaign" boolean ["sources"] array The possible sources of any events that can trigger the webhook and whether they are enabled. "user" boolean "admin" boolean "api" boolean

Parameters

$list_id
$data

Returns

object
public
# deleteWebhook( string $list_id, string $webhook_id )

Delete a webhook

Delete a webhook

Parameters

$list_id
$webhook_id

Methods inherited from MailChimp\Lists\Lists

batchMembers(), createList(), deleteList(), getAbuseReport(), getAbuseReports(), getActivity(), getClients(), getGrowthHistory(), getGrowthHistoryMonth(), getList(), getLists(), interests(), members(), mergeFields(), segments(), signupForms(), updateList(), webhooks()

Methods inherited from MailChimp\MailChimp

__construct(), authorizedApps(), automations(), batchOps(), campaignFolders(), campaigns(), conversations(), createLog(), ecommerce(), execute(), fileManager(), fileManagerFolders(), getAccountInfo(), getMemberHash(), lists(), logData(), optionalFields(), reports(), searchMembers(), templateFolders(), templates()

API documentation generated by ApiGen