According to Wikipedia:
Webhooks are "user-defined HTTP callbacks". They are usually triggered by some event, such as pushing code to a repository or a comment being posted to a blog. When that event occurs, the source site makes an HTTP request to the URL configured for the webhook. Users can configure them to cause events on one site to invoke behavior on another.
A hook allows you to trigger a URL based on some event on our side. For instance, we provide hooks on rental update, that will fire every time a rental is updated.
When a hook event is fired, we will call the registered URL and pass some hook-specific parameters. You can find out how to setup web hooks as well as what parameters are sent in each web hook down below.
You can set web hooks from your Partner Interface:
https://partner.digital-nautic.com/admin/partner/webhooks/index
Each hook sends data in a standard POST, of the mime type application/json.
| Hook name | Parameters |
|---|---|
| Rental / Update | { type: 'RENTAL_UPDATE', rentaldId: number } |
| Rental / Validated | { type: 'RENTAL_VALIDATED', rentalId: number } |
| Rental / User Update | { type: 'RENTAL_USER_UPDATE', profileId: number } |
| Rental / Option Add | { type: 'RENTAL_OPTION_ADD', rentalId: number, rentalOptionId: number } |
| Rental / Option Update | { type: 'RENTAL_OPTION_UPDATE', rentalId: number, rentalOptionId: number } |
| Rental / Option Delete | { type: 'RENTAL_OPTION_DELETE', rentalId: number, rentalOptionId: number } |
| Rental / Payment Add | { type: 'RENTAL_PAYMENT_ADD', rentalId: number, paymentId: number } |
| Rental / Payment Update | { type: 'RENTAL_PAYMENT_UPDATE', rentalId: number, paymentId: number } |
| Rental / Payment Delete | { type: 'RENTAL_PAYMENT_DELETE', rentalId: number, paymentId: number } |
| Resource / Publication Add | { type: 'RESOURCE_PUBLICATION_ADD', resourceId: array } |
| Resource / Publication Update | { type: 'RESOURCE_PUBLICATION_UPDATE', resourceId: array } |
| Resource / Publication Delete | { type: 'RESOURCE_PUBLICATION_DELETE', resourceId: array } |
| Resource / Availability Update | { type: 'RESOURCE_AVAILABILITY_UPDATE', resourceId: number } |
| Resource / Pricings Update | { type: 'RESOURCE_PRICING_UPDATE', resourceId: number } |
| Resource / Option Add | { type: 'RESOURCE_OPTION_ADD', resourceId: number, optionId: number } |
| Resource / Option Update | { type: 'RESOURCE_OPTION_UPDATE', resourceId: number, optionId: number } |
| Resource / Option Delete | { type: 'RESOURCE_OPTION_DELETE', resourceId: number, optionId: number } |
| Company / Create | { type: 'COMPANY_CREATE', companyId: number } |
| Company / Update | { type: 'COMPANY_UPDATE', companyId: number } |
| Company / Delete | { type: 'COMPANY_DELETE', companyId: number } |