Skip to main content

​
Description

A webhook is a technical approach that allows Mangopay to submit a notification to other applications whenever a specific event occurs. The Hook object allows you to receive notifications, to a URL you define, that are triggered by a specific event type. You can set up only one URL for each event type.
Best practice – Idempotent hook processingThe retry feature (i.e., new notification if your app was unreachable) can set the hook to INVALID. We strongly recommend you make your event processing idempotent to avoid receiving duplicate notifications for the same events.

​
Attributes

​
Url
string
Max. length: 255 charactersThe URL (http or https) to which the notification is sent.
​
Status
string
Returned values: DISABLED, ENABLEDWhether the hook is enabled or not.
​
Validity
string
Returned values: VALID, INVALIDWhether 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 listThe type of the event.

Guide

Learn more about hook notifications