Overview

Push messages enable the integration of the AMFG application with third-party software services, such as accounting or invoicing tools. AMFG sends JSON-formatted messages via a REST API, triggered by events configured within your application.

This guide provides information on the types of push messages available in AMFG, the configurable trigger criteria for the messages, and how to set them up.

There are three types of push messages in AMFG:

Order Push Message
- Can be triggered when:
  - Order status is set or changed (to a defined status)
  - Part status is changed in an Order (to a defined status)
  - A Quote is submitted
  - Quote status is set or changed (to a defined status)
Customer Push Message
- Can be triggered when:
  - Customer (Contact) status is set or changed (to a defined status)
    Note: Customer push triggers when the Contact details are changed, also (name, email, region, etc.)
Build Push Message - instructions can be found in a separate article
- Can be triggered when:
  - Build status is set or changed (to a defined status)

The Order and Customer Push Messages can be configured directly in your AMFG application. While the Build Push Messages have to be configured by the AMFG support team (you can request this via our in-app support chat - the blue bubble in the bottom left corner of the app, or by reaching out to support@amfg.ai).

Setting Up a Push Message

1. Configure an endpoint URL (Webhook)

In order to receive the push messages from AMFG, you need to have an active endpoint URL (a webhook). This can be done externally in the system that you want to integrate with AMFG.

For example, one of the available methods for creating an endpoint is to create a custom webhook using the Make.com service:

See below the steps on how to create an endpoint (webhook) in Make.com:

1. Sign in to Make.com - https://www.make.com/

2. Create a new Scenario:

3. Click the "+" icon and search for "Webhooks". After selecting Webhooks, select the custom webhook:

4. Click on the “Add” button:

5. Save the webhook:

6. After saving, the endpoint URL should be created:

2. Set up API Keys (required)

Open the AMFG Management console, navigate to Settings -> API Keys
Select "Create Secret"
Name is the name of the Secret Key (any name)
Type: Outgoing refers to Push Messages Sent out
Secret:
1. Can be free text or randomly generated
2. Once saved, it will not be viewable again. Copy the secret securely so that it can be used by your third-party integrated application, if needed.
Once this is configured and the secret is created, in Settings -> Workflow Automation, the relevant authorization keys will appear in the dropdown for Authorization Secret

3. Setting up Order Push Messages in AMFG

It is important to note that Order Push Messages can be sent for confirmed Orders, Tickets, or Quotations, only from the Order Push v1.11 and above.

Please refer to this article for information regarding all available Order Push versions.

Please follow the instructions below to set up an Order Push message through the Workflow Automation rules:

Navigate to Autonomous -> Workflow Automation page
Click “Create rule.”
Select “IF -> Ticket status/ Part status/ Quote submitted/Quote status”
Select “THEN -> Send Push Message”
You will now need to fill in the following fields:
- Type: Order Push Message
- Select Push Version (select from the list, see the latest version if this is the first time you are using the Push messages or any other version as applicable if you have used a different one before /Latest version is "v1.18")
- The https:// webhook URL that you are pushing to (generated from Make.com or other applicable service)
- A Header message (included in the JSON header) - this could be just brackets "{}" if it has to be empty.
- The Authorization Header Name will be any key (this will appear as the Header on your Push notification sent to the webhook, and the value of this key will be the secret set in the next field.
- Authorization Secret - select from the drop-down list (use the secrets created by following the instructions from point 2.)
- Signature Secret - select the same as the Authorization Secret (this is an extra security layer, creating a unique HMAC secret for each application)
  Note: On the information icon of the Signature Secret, there is a tooltip icon with info on how to validate the signature (there's a JS code that can be used for validation, static text)
- Email (input an email address where an error log will be emailed to, should the automation fail for some reason)