The Hook object
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 processing
The 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
Max. length: 255 characters
The URL (http or https) to which the notification is sent.
Returned values: DISABLED, ENABLED
Whether the hook is enabled or not.
Returned values: VALID, INVALID
Whether the hook is valid or not. Once INVALID (following unsuccessful retries) the hook must be disabled and re-enabled.
Returned values: An EventType listed in the event types list
The type of the event.