How to Use our Joomla® Extensions e4j Knowledge Base

Knowledge Base  >  Vik Appointments  >  Webhooks  >  Supported Actions

Supported Actions

In this section you can find a description for every supported action, the related parameters and what kind of data are sent to the delivery URL.

Appointments - Delete

Fires the webhook every time an appointments is deleted.

Parameters

This action doesn't support additional parameters.

Payload

A json object containing the id property and the real ID of the deleted appointment.

{
    id: 10
}

In case multiple appointments are deleted simultaneously, the value of id will be an array:

{
    id: [10, 11, 12]
}

Appointments - Save

Fires the webhook every time an appointment is created or updated.

Parameters

  • Type - Choose whether the webhook should be dispatched only for created records, updated records or both.
  • Status - The webhook will be dispatched only in case the status changed is contained within this list. Leave empty to observe all the statuses.
  • Loading Mode - Choose how the system should load the details of the payload:
    • use Basic to send only the details that have been saved;
    • use Full to send the whole database table row;
    • use Extended to send an object containing all the details of the appointment.

Payload

The payload varies according to the specified loading mode. It is suggested to look into the logs to understand how the payload is built.


Appointments - Status Change

Fires the webhook every time the status of an appointment changes.

Parameters

  • Status - The webhook will be dispatched only in case the status changed is contained within this list. Leave empty to observe all the statuses.
  • Loading Mode - Choose how the system should load the details of the payload:
    • use Basic to send only the details that have been saved;
    • use Full to send the whole database table row;
    • use Extended to send an object containing all the details of the appointment.

Payload

The payload varies according to the specified loading mode. It is suggested to look into the logs to understand how the payload is built.


Coupon - Delete

Fires the webhook every time a coupon is deleted. 

Parameters

This action doesn't support additional parameters.

Payload

A json object containing the id property and the real ID of the deleted coupon.

{
    id: 10
}

In case multiple coupons are deleted simultaneously, the value of id will be an array:

{
    id: [10, 11, 12]
}

Coupon - Save

Fires the webhook every time a coupon is created or updated.

Parameters

  • Type - Choose whether the webhook should be dispatched only for created records, updated records or both.
  • Loading Mode - Choose how the system should load the details of the payload:
    • use Basic to send only the details that have been saved;
    • use Full to send the whole database table row.

Payload

The payload varies according to the specified loading mode. It is suggested to look into the logs to understand how the payload is built.


Customer - Delete

Fires the webhook every time a customer is deleted.

Parameters

This action doesn't support additional parameters.

Payload

A json object containing the id property and the real ID of the deleted customer.

{
    id: 10
}

In case multiple customers are deleted simultaneously, the value of id will be an array:

{
    id: [10, 11, 12]
}

Customer - Save

Fires the webhook every time a customer is created or updated.

Parameters

  • Type - Choose whether the webhook should be dispatched only for created records, updated records or both.
  • Loading Mode - Choose how the system should load the details of the payload:
    • use Basic to send only the details that have been saved;
    • use Full to send the whole database table row.

Payload

The payload varies according to the specified loading mode. It is suggested to look into the logs to understand how the payload is built.


Employee - Delete

Fires the webhook every time an employee is deleted. 

Parameters

This action doesn't support additional parameters.

Payload

A json object containing the id property and the real ID of the deleted employee.

{
    id: 10
}

In case multiple employees are deleted simultaneously, the value of id will be an array:

{
    id: [10, 11, 12]
}

Employee - Save

Fires the webhook every time an employee is created or updated.

Parameters

  • Type - Choose whether the webhook should be dispatched only for created records, updated records or both.
  • Loading Mode - Choose how the system should load the details of the payload:
    • use Basic to send only the details that have been saved;
    • use Full to send the whole database table row.

Payload 

The payload varies according to the specified loading mode. It is suggested to look into the logs to understand how the payload is built. 


Packages Order - Delete

Fires the webhook every time a packages order is deleted.

Parameters

This action doesn't support additional parameters.

Payload

A json object containing the id property and the real ID of the deleted packages order.

{
    id: 10
}

In case multiple packages orders are deleted simultaneously, the value of id will be an array:

{
    id: [10, 11, 12]
}

Packages Order - Save

Fires the webhook every time a packages order is created or updated.

Parameters 

  • Type - Choose whether the webhook should be dispatched only for created records, updated records or both.
  • Loading Mode - Choose how the system should load the details of the payload:
    • use Basic to send only the details that have been saved;
    • use Full to send the whole database table row;
    • use Extended to send an object containing all the details of the packages order.

Payload

The payload varies according to the specified loading mode. It is suggested to look into the logs to understand how the payload is built.


Packages Order - Status Change

Fires the webhook every time the status of a packages order changes.

Parameters 

  • Status - The webhook will be dispatched only in case the status changed is contained within this list. Leave empty to observe all the statuses.
  • Loading Mode - Choose how the system should load the details of the payload:
    • use Basic to send only the details that have been saved;
    • use Full to send the whole database table row;
    • use Extended to send an object containing all the details of the packages order.

Payload

The payload varies according to the specified loading mode. It is suggested to look into the logs to understand how the payload is built.


Service - Delete

Fires the webhook every time a service is deleted.

Parameters

This action doesn't support additional parameters.

Payload

A json object containing the id property and the real ID of the deleted service 

{
    id: 10
}

In case multiple services are deleted simultaneously, the value of id will be an array:

{
    id: [10, 11, 12]
}

Service - Save

Fires the webhook every time a service is created or updated.

Parameters 

  • Type - Choose whether the webhook should be dispatched only for created records, updated records or both.
  • Loading Mode - Choose how the system should load the details of the payload:
    • use Basic to send only the details that have been saved;
    • use Full to send the whole database table row.

Payload

The payload varies according to the specified loading mode. It is suggested to look into the logs to understand how the payload is built.


Custom

It is possible to use any of the plugin events supported by the plugin, simply by specifying the event name into the apposite parameter.

You can take a look at our documentation for further details:
https://extensionsforjoomla.com/answers-area/knowledge-base/vik-appointments/plugin-events

The payload will specify the same parameters mentioned within the documentation of the selected event. In example, in case you wish to invoke a webhook every time someone adds an appointment into the cart, the event to use will be equals to onAddItemCart, and the payload will look like this one:

{
    arg1: {},
    arg2: {},
    arg3: ""
}

where arg1 is an object containing the cart details, arg2 is an object containing the details of the added appointment and arg3 is a string containing an error message in case of failure. Here's the documentation of the mentioned plugin event: https://extensionsforjoomla.com/answers-area/knowledge-base/vik-appointments/plugin-events/cart/appointments/add-item

Last Update: 2022-03-01
Helpful?
See Also:

Extensionsforjoomla.com is not affiliated with or endorsed by the Joomla!® Project or Open Source Matters.
The Joomla!® name and logo is used under a limited license granted by Open Source Matters the trademark holder in the United States and other countries.
E4J s.r.l. - VAT N. 06794860483

This site uses cookies. By continuing to browse you accept their use. Further information