Methods

Objects

webhooks

Webhooks management.

Method Description
webhooks.disable Disables a Webhook (if it was previously enabled)
webhooks.enable Enables a Webhook (if it was previously disabled)
webhooks.get Returns a Webhook
webhooks.get_event_types Returns available hook types.
webhooks.get_list Returns the subscribed webhooks.
webhooks.search_logs Searches through the webhooks push logs
webhooks.subscribe Subscribes a new Webhook
webhooks.unsubscribe Unsubscribes a Webhook

Methods

webhooks.disable

Description

Disables a Webhook (if it was previously enabled)

Signature

method: webhooks.disable

params: [string hash]

Parameters

Parameter Type Description NULL
hash string Webhook ID
Format: hash (Unique object identifier) 		NO

Result

Type Description Format/Object
object Webhook Object: Webhook

webhooks.enable

Description

Enables a Webhook (if it was previously disabled)

Signature

method: webhooks.enable

params: [string hash]

Parameters

Parameter Type Description NULL
hash string Webhook ID
Format: hash (Unique object identifier) 		NO

Result

Type Description Format/Object
object Webhook Object: Webhook

webhooks.get

Description

Returns a Webhook

Signature

method: webhooks.get

params: [string hash]

Parameters

Parameter Type Description NULL
hash string Webhook ID
Format: hash (Unique object identifier) 		NO

Result

Type Description Format/Object
object Webhook Object: Webhook

webhooks.get_event_types

Description

Returns available hook types.

Signature

method: webhooks.get_event_types

params: []

Parameters

No parameters.

Result

Type Description Format/Object
array Types

webhooks.get_list

Description

Returns the subscribed webhooks.

Signature

method: webhooks.get_list

params: []

Parameters

No parameters.

Result

Type Description Format/Object
array Webhooks Array of Webhook objects.

webhooks.search_logs

Description

Searches through the webhooks push logs

Signature

method: webhooks.search_logs

params: [object filters, object options]

Parameters

Parameter Type Description NULL
filters object Search filters
Object: Webhook.Log.Search.Filters 		NO
options object Search options
Object: Search.Options 		NO

Result

Type Description Format/Object
object Search results Object: Search.Results

webhooks.subscribe

Description

Subscribes a new Webhook

Signature

method: webhooks.subscribe

params: [string type, string endpoint, object options]

Parameters

Parameter Type Description NULL
type string Webhook type NO
endpoint string Your URL NO
options object Options
Object: Webhook.Options 		YES

Result

Type Description Format/Object
object Webhook object Object: Webhook

See Also

webhooks.unsubscribe

Description

Unsubscribes a Webhook

Signature

method: webhooks.unsubscribe

params: [string hash]

Parameters

Parameter Type Description NULL
hash string Webhook ID
Format: hash (Unique object identifier) 		NO

Result

Type Description Format/Object
bool true (or throws an Exception otherwise)