Webhooks

View a Hook

Changed on

View a Hook

get/v2.01/{ClientId}/hooks/{HookId}

Request

  • Base URL
    https://api.sandbox.mangopay.com
  • URL
    https://api.sandbox.mangopay.com/v2.01/{ClientId}/hooks/{HookId}
  • Auth
    HTTP bearer

Path parameters

ClientIdstring required

Platform's API account identifier, associated with the API key.

HookIdstring required

The unique identifier of the hook.

Response

Success

Urlstring

Max. length: 255 characters

The URL to which the notification is sent.

Statusstring

Returned values: DISABLED, ENABLED

Whether the hook is enabled or not.

Validitystring

Returned values: VALID, INVALID

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

EventTypestring

Returned values: An EventType listed in the <a href="/webhooks/event-types">event types list</a>

The type of the event.

Idstring

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

The unique identifier of the object.

Tagstring

Max. length: 255 characters

Custom data that you can add to this object, such as unique identifiers in your system. To store multiple values, you can serialize them into a single string, for example a JSON object: "{\"id_1\":AB123,\"id_2\":DE456}".

CreationDateinteger

Unix timestamp (UTC) of the date and time the object was created.

Emailstring

Format: A valid email address

The Email address to which alerts are sent in case of consecutive failed notification attempts.

Caution: Mangopay may populate this property automatically if your platform had webhooks integrated in Production before April 2, 2026. If so, setting the Email on a single Hook stops this automatic population for any new Hooks you create - read more.

For all platforms, if this property is returned null then no alerts are sent but the Hook still becomes INVALID after 100 consecutive failed notifications.

Changes