Connecter un périphérique webhook

Mis à jour

Remarque : Cet article est technique ; nous vous recommandons d'impliquer une personne disposant des compétences techniques appropriées. Si vous avez des questions, contactez-nous à support@azumuta.com.

Un périphérique webhook permet à un système externe de remplir la réponse d'un product check. Lorsque l'opérateur atteint l'étape, Azumuta appelle votre webhook, lit la valeur dans la réponse et l'utilise comme réponse. Par exemple, un service de mesure peut renvoyer la valeur mesurée d'une pièce, évitant ainsi à l'opérateur de la saisir.

Ce sont les serveurs d'Azumuta qui appellent le webhook, vous n'avez donc pas besoin du Hub ni d'aucun logiciel sur le poste de travail.

Ce dont vous avez besoin

  • A webhook endpoint que les serveurs d'Azumuta peuvent joindre. Il doit être accessible depuis Internet, pas seulement depuis l'ordinateur de l'opérateur. Pour remplir une réponse, il doit renvoyer du JSON.
  • The rights pour gérer les périphériques et les appareils sous Management, et pour modifier les instructions de travail.
  • A supported check. Un périphérique webhook fonctionne avec les contrôles OK/NOK, Number, Single Line et Paragraph. Le contrôle Procedure peut aussi utiliser un webhook, ou sa propre action webhook. Voir Procedure check.

Create the peripheral

  1. Click Peripherals under Management.
  2. Click the yellow plus button.
  3. Type a Name and select or create the Peripheral group.
  4. Under How to connect?, select Webhook
  5. Fill in the webhook fields.
  6. When you’re done, click Add.

Webhook fields

  • Webhook URL: the full http or https address of your endpoint.
  • Method: POST, GET, PUT or PATCH.
  • Authentication: how Azumuta identifies itself to your endpoint: None, Header, Basic or OAuth client credentials. These work in the same way for webhook triggers. See Authentication.
  • Payload format and Webhook payload: With Azumuta format, your payload is sent inside Azumuta’s JSON body, next to the event fields. With JSON, XML, CSV or Text, only your payload is sent, with the matching content type. You can use parameters in the payload.
  • When to run the webhook:
    • Automatic on first visit: the first time the operator opens the step.
    • Automatic on every visit: every time the operator opens the step.
    • Manual: the operator presses a button.
  • Response format: JSON.
  • Webhook result parameter: where Azumuta finds the answer in the JSON response, for example data.result.value for a response like { "data": { "result": { "value": 17.3 } } }. Leave it empty to use the whole response.
  • Webhook remark parameter: where Azumuta finds a remark message in the JSON response.

Azumuta ajoute le numéro de commande produit ainsi que les IDs de l'instruction de travail et de l'enregistrement (le cas échéant) à l'appel : en tant que paramètres d'URL pour GET, et dans le corps JSON pour le Azumuta format.

Add the peripheral to a device

Un contrôle trouve son périphérique via l'appareil et le groupe de périphériques. Ajoutez le périphérique à chaque appareil où les opérateurs exécutent l'instruction de travail :

  1. Click Devices under Management.
  2. Click the ⋮ (three-dot) icon next to the device, and click Edit device.
  3. Click the Peripherals tab.
  4. Under Peripherals for instruction checks, select the webhook peripheral.
  5. Click Save.

Use the peripheral on a check

  1. Open the instruction step and click the Check tab.
  2. Select a supported check.
  3. Under Peripheral options, select the Peripheral group of your webhook peripheral. You can also apply a peripheral preset.
  4. Adjust the options if needed:
    • Payload: remplace la payload définie sur le périphérique pour ce contrôle. Laissez vide pour utiliser celle du périphérique. Écrivez-la dans le format de payload du périphérique.
    • Automatically submit answer after: soumet la réponse 0 à 10 secondes après qu'elle a été renseignée. Non disponible pour le contrôle OK/NOK.
    • Allow manually entering answer: permet à l'opérateur de taper ou modifier la réponse. Activée par défaut.

Example

Un service qualité renvoie la valeur mesurée d'une pièce. Votre point de terminaison est https://qc.example.com/api/measurement et répond avec :

{
  "data": {
    "value": 17.3,
    "remark": "Within tolerance"
  }
}

Pour l'utiliser sur un contrôle Number :

  1. Create a peripheral group for the Number check, for example "External measurement".
  2. Create a webhook peripheral in that group, with Method POST, Webhook result parameter data.value, Webhook remark parameter data.remark, and When to run the webhook set to Automatic on first visit.
  3. Add the peripheral to the device that operators use.
  4. Add a Number check to the instruction step, and select the group under Peripheral options.

Lorsque l'opérateur ouvre l'étape, Azumuta appelle le endpoint et renseigne 17.3 comme réponse.

If your endpoint is unavailable

Pour permettre aux opérateurs de continuer pendant que votre endpoint est indisponible, cochez Disable peripheral temporarily sur le périphérique. Les opérateurs peuvent alors saisir les réponses manuellement. Voir Use a peripheral device.

Choose the right webhook

  • Pour remplir la réponse d'un contrôle depuis un système externe, utilisez un périphérique webhook, comme décrit ici.
  • Pour valider une étape, utilisez l'action webhook d'un Procedure check.
  • Pour notifier un autre système lorsqu'un événement se produit, utilisez un webhook trigger.
Sur cette page