List all Hooks

This call returns all the Hooks that have been created for the platform. It includes both enabled and disabled hooks.

Responses

200

Array (Hooks) · array

The list of hooks created by the platform.

Show properties

Hook · object

The hook object created by the platform.

Show properties

Url · string

Max. length: 255 characters

The URL to which the notification is sent.

Status · string

Returned values: DISABLED, ENABLED

Whether the hook is enabled or not.

Validity · string

Returned values: VALID, INVALID

Whether the hook is valid or not. Once INVALID (following unsuccessful retries) the hook must be disabled and re-enabled.

EventType · string

Returned values: An EventType listed in the event types list

The type of the event.

Id · string

Max length: 128 characters (see data formats for details)

The unique identifier of the object.

Tag · string

Max. length: 255 characters

Custom data that you can add to this object.

CreationDate · Unix timestamp

The date and time at which the object was created.

200

[
    {
        "Url": "https://example.com",
        "Status": "ENABLED",
        "Validity": "VALID",
        "EventType": "PAYIN_NORMAL_CREATED",
        "Id": "hook_m_01J6EK0ZRRGKZH98RCDWB7Y3KJ",
        "Tag": "Created using the Mangopay API Postman Collection",
        "CreationDate": 1724919086
    },
    {
        "Url": "https://example.com",
        "Status": "ENABLED",
        "Validity": "VALID",
        "EventType": "UBO_DECLARATION_VALIDATION_ASKED",
        "Id": "hook_m_01J6EK16AS02MV3H4AMMXMQWZ1",
        "Tag": "Created using the Mangopay API Postman Collection",
        "CreationDate": 1701792699
    }
]  

PHP

<?php 

require_once 'vendor/autoload.php';

use MangoPay\MangoPayApi;
use MangoPay\Libraries\ResponseException as MGPResponseException;
use MangoPay\Libraries\Exception as MGPException;

$api = new MangoPayApi();

$api->Config->ClientId = 'your-client-id';
$api->Config->ClientPassword = 'your-api-key';
$api->Config->TemporaryFolder = 'tmp/';

try {
    $response = $api->Hooks->GetAll();

    print_r($response);
} catch(MGPResponseException $e) {
    print_r($e);
} catch(MGPException $e) {
    print_r($e);
}