Webhooks

Create a Hook

Changed on
<Warning icon="fa-regular fa-triangle-exclamation"> **Caution – Setting email for consecutive failures after April 2026**

In Production, if your platform had VALID Hook objects before April 2, 2026, then Mangopay automatically populates the Email property on new Hooks with the previously used global address unless and until you set it proactively using this endpoint.

If you send the Email on a POST or PUT request, other new Hooks created without the Email do not populate the Email automatically and do not emit alerts in case of consecutive failed notifications or if the Hook becomes INVALID.

Platforms integrating after April 2, 2026 must proactively set the Email to receive alerts.

Read more about this change → </Warning>

post/v2.01/{ClientId}/hooks

Request

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

Path parameters

ClientIdstring required

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

Request body

EventTypestring required

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

The type of the event.

Urlstring required

Max. length: 255 characters

The URL to which the notification is sent.

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}".

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.

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