Skip to content

Webhooks

Update on the Core & UI to have the Webhook functionality in synQup. The main synqup url to execute a Webhook Entry is /api/webhook/{identifier}/execute. But first, to create a Webhook entry, a CRUD table was also developed in the UI that contains the input fields: Identifier, Description, Type, & Parameters.

The Identifier serves as the key of the Webhook. The Description field is also included here to add a little bit of information about the Webhook Entry. For the Type Field, this is an option that contains two choices: command or api.

The Command Type is for executing symfony/synqup commands inside the container using the Webhook Controller. For the Parameters of the Command Type: A JSON value with the keys “command” & “parameters”.

{
  "command": "synqup:flow:start",
  "arguments": [
    "1",
    "--force-removal"
  ]
}

The API Type is simply for calling an endpoint on a synqup container and for its Parameters, its also a JSON value but with the keys “body”, “endpoint”, & “method”.

{
  "body": [],
  "method": "post",
  "endpoint": "/api/flows/1/start"
}

Suggested Feature: It will also be good to have a logging mechanism here in the webhook where we store all the history of the webhooks being executed/called.