Sign in

v2

latestOpenAPI 3.1.02026-07-262279731.3 MB
Webhooks

Update a Hook

<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 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>

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

Path parameters

ClientIdstring required

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

HookIdstring required

The unique identifier of the hook.

Headers

Authorizationstring required

Bearer authentication of the form Bearer <token>, where token is your auth token.

If your platform is using a proxy to take SCA-triggering action on behalf of users, you also need to integrate mTLS authentication and use the api-mtls base URL.

Request body

Urlstring

The URL to which the notification is sent.

Statusstring

Allowed values: DISABLED, ENABLED

Whether the hook is enabled or not.

Tagstring

Custom data that you can add to this object.

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.

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.