rpaix helprpaix help

AIX.API

home/Documentation/AIX.API
Expand All Collapse All
  • Getting Started
  • Usage
  • Users
    • get-user
    • get-user-by
    • get-user-extra
    • get-user-language
    • get-users
  • Webhooks
    • message-sent
    • email-sent
    • sms-sent
    • new-messages-received
    • bot-message

Webhooks

12 views 0 August 23, 2023 Updated on October 16, 2023 rpaix-chat-team

Webhooks are automated messages sent from AiX to a URL when something happens. They contain custom data and are sent to a unique URL defined by you.

Usage

  • Login to the administration area and go to Settings > Miscellaneous > Webhooks.
  • Enter the destination URL. AiX will send the data to this URL. This URL should point to a PHP file that can read the data received, you can use the code $response = json_decode(file_get_contents('php://input'), true); to get the data, the $responsevariable will be an array.
  • Enter in the Secret key field a secret password of your choice. This key is included in all the Webhooks, you can use it to validate the Webhook and make sure it is sent by AiX and not from someone else.
  • Activate the Webhooks and save. AiX will now start sending the Webhooks of the list below to your URL.
  • The key sender-url is included in all the Webhooks and contains the URL from which the webhook is sent.
  • The setting Active webhooks defines what webhooks are active. Enter names of the webhooks separated by commas. Leave it empty to enable all webhooks.

Was this helpful?

Yes  No
Related Articles
  • bot-message
  • new-messages-received
  • sms-sent
  • email-sent
  • message-sent
  • get-users

Didn't find your answer? Contact Us

Previously
get-users
Up Next
message-sent
© 2023 rpaix.com. All Rights Reserved.