API Documentation
\

\Simplify_Webhook

Base class for all domain objects.

Summary

Methods
Properties
Constants
createWebhook()
deleteWebhook()
listWebhook()
findWebhook()
updateWebhook()
setAll()
getProperties()
No public properties found
No constants found
No protected methods found
No protected properties found
N/A
No private methods found
$properties
N/A

Properties

$properties

$properties

Methods

createWebhook()

createWebhook(array $hash, mixed $authentication) : \Webhook

Creates an Simplify_Webhook object

Parameters

array $hash

a map of parameters; valid keys are:

url
Endpoint URL required
mixed $authentication
  • information used for the API call. If no value is passed the global keys Simplify::public_key and Simplify::private_key are used. For backwards compatibility the public and private keys may be passed instead of the authentication object.<i/>

Returns

\Webhook —

a Webhook object.

deleteWebhook()

deleteWebhook(mixed $authentication)

Deletes an Simplify_Webhook object.

Parameters

mixed $authentication
  • information used for the API call. If no value is passed the global keys Simplify::public_key and Simplify::private_key are used. For backwards compatibility the public and private keys may be passed instead of the authentication object.

listWebhook()

listWebhook( $criteria, mixed $authentication) : \ResourceList

Retrieve Simplify_Webhook objects.

Parameters

$criteria
mixed $authentication
  • information used for the API call. If no value is passed the global keys Simplify::public_key and Simplify::private_key are used. For backwards compatibility the public and private keys may be passed instead of the authentication object.

Returns

\ResourceList —

a ResourceList object that holds the list of Webhook objects and the total number of Webhook objects available for the given criteria.

findWebhook()

findWebhook( $id, mixed $authentication) : \Webhook

Retrieve a Simplify_Webhook object from the API

Parameters

$id
mixed $authentication
  • information used for the API call. If no value is passed the global keys Simplify::public_key and Simplify::private_key are used. For backwards compatibility the public and private keys may be passed instead of the authentication object.

Returns

\Webhook —

a Webhook object

updateWebhook()

updateWebhook(mixed $authentication) : \Webhook

Updates an Simplify_Webhook object.

The properties that can be updated:

url
Endpoint URL required

Parameters

mixed $authentication
  • information used for the API call. If no value is passed the global keys Simplify::public_key and Simplify::private_key are used. For backwards compatibility the public and private keys may be passed instead of the authentication object.

Returns

\Webhook —

a Webhook object.

setAll()

setAll(mixed $hash)

Updates the object's properties with the values in the specified map.

Parameters

mixed $hash

array Map of values to set.

getProperties()

getProperties() : array

Returns the object's properties as a map.

Returns

array —

map of properties.