Trigger a Webhook (GET)

curl --request GET \
  --url https://flowker.sandbox.lerian.net/v1/webhooks/{path} \
  --header 'Authorization: Bearer <token>'

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://flowker.sandbox.lerian.net/v1/webhooks/{path}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://flowker.sandbox.lerian.net/v1/webhooks/{path}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://flowker.sandbox.lerian.net/v1/webhooks/{path}"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://flowker.sandbox.lerian.net/v1/webhooks/{path}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body

{
  "executionId": "f7e6d5c4-b3a2-1098-7654-321fedcba098",
  "workflowId": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
  "status": "completed",
  "stepResults": [
    {
      "stepNumber": 1,
      "stepName": "action_log-event",
      "nodeId": "log-event",
      "status": "completed",
      "output": {
        "action": "log"
      },
      "executedAt": "2026-03-17T14:35:00Z",
      "durationMs": 0
    }
  ],
  "finalOutput": {
    "workflow": {
      "transactionId": "txn-98765",
      "amount": 1500,
      "currency": "BRL",
      "customerId": "cust-12345",
      "message": "Payment received"
    }
  },
  "startedAt": "2026-03-17T14:35:00Z",
  "completedAt": "2026-03-17T14:35:00Z"
}

{
  "executionId": "f7e6d5c4-b3a2-1098-7654-321fedcba098",
  "startedAt": "2026-03-17T14:35:00Z",
  "status": "running",
  "workflowId": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
}

{
  "code": "FLK-0361",
  "message": "no webhook registered for this path and method",
  "title": "Not Found"
}

{
  "code": "FLK-0361",
  "message": "no webhook registered for this path and method",
  "title": "Not Found"
}

{
  "code": "FLK-0361",
  "message": "no webhook registered for this path and method",
  "title": "Not Found"
}

{
  "code": "FLK-0361",
  "message": "no webhook registered for this path and method",
  "title": "Not Found"
}

{
  "code": "FLK-0361",
  "message": "no webhook registered for this path and method",
  "title": "Not Found"
}

{
  "code": "FLK-0361",
  "message": "no webhook registered for this path and method",
  "title": "Not Found"
}

GET

webhooks

{path}

Trigger a Webhook (GET)

curl --request GET \
  --url https://flowker.sandbox.lerian.net/v1/webhooks/{path} \
  --header 'Authorization: Bearer <token>'

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://flowker.sandbox.lerian.net/v1/webhooks/{path}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://flowker.sandbox.lerian.net/v1/webhooks/{path}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://flowker.sandbox.lerian.net/v1/webhooks/{path}"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://flowker.sandbox.lerian.net/v1/webhooks/{path}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body

{
  "executionId": "f7e6d5c4-b3a2-1098-7654-321fedcba098",
  "workflowId": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
  "status": "completed",
  "stepResults": [
    {
      "stepNumber": 1,
      "stepName": "action_log-event",
      "nodeId": "log-event",
      "status": "completed",
      "output": {
        "action": "log"
      },
      "executedAt": "2026-03-17T14:35:00Z",
      "durationMs": 0
    }
  ],
  "finalOutput": {
    "workflow": {
      "transactionId": "txn-98765",
      "amount": 1500,
      "currency": "BRL",
      "customerId": "cust-12345",
      "message": "Payment received"
    }
  },
  "startedAt": "2026-03-17T14:35:00Z",
  "completedAt": "2026-03-17T14:35:00Z"
}

{
  "executionId": "f7e6d5c4-b3a2-1098-7654-321fedcba098",
  "startedAt": "2026-03-17T14:35:00Z",
  "status": "running",
  "workflowId": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
}

{
  "code": "FLK-0361",
  "message": "no webhook registered for this path and method",
  "title": "Not Found"
}

{
  "code": "FLK-0361",
  "message": "no webhook registered for this path and method",
  "title": "Not Found"
}

{
  "code": "FLK-0361",
  "message": "no webhook registered for this path and method",
  "title": "Not Found"
}

{
  "code": "FLK-0361",
  "message": "no webhook registered for this path and method",
  "title": "Not Found"
}

{
  "code": "FLK-0361",
  "message": "no webhook registered for this path and method",
  "title": "Not Found"
}

{
  "code": "FLK-0361",
  "message": "no webhook registered for this path and method",
  "title": "Not Found"
}

Authorizations

Authorization

string

header

required

JWT bearer token issued by the identity provider. Send it in the Authorization header as Bearer <token>.

Headers

Idempotency-Key

string

Optional idempotency key to prevent duplicate executions from the same webhook delivery.

Path Parameters

path

string

required

Webhook path registered by a workflow. Supports nested paths with multiple segments at runtime. Forward slashes within the path must be percent-encoded as %2F per RFC 3986/OpenAPI 3.1 (for example, use orders%2Fpaid for orders/paid).

Response

The workflow finished inside the synchronous window. The body carries the final business results. An XML route returns the equivalent <results> document.

completedAt

string<date-time>

Timestamp when the execution finished.

Example:

"2026-03-17T14:35:12Z"

executionId

string<uuid>

Unique identifier of the execution.

Example:

"f7e6d5c4-b3a2-1098-7654-321fedcba098"

finalOutput

object

Aggregated output from the last step or the workflow's final result.

Show child attributes

Example:

{
  "workflow": {
    "transactionId": "txn-98765",
    "amount": 1500,
    "currency": "BRL",
    "customerId": "cust-12345",
    "message": "Payment received"
  }
}

startedAt

string<date-time>

Timestamp when the execution started.

Example:

"2026-03-17T14:35:00Z"

status

string

Final status of the execution.

Example:

"completed"

stepResults

object[]

Ordered list of results for each step executed.

Show child attributes

workflowId

string<uuid>

ID of the workflow that was executed.

Example:

"a1b2c3d4-e5f6-7890-abcd-ef1234567890"

⌘I

Getting started

Catalog API

Workflows API

Schedule API

Executions API

Dashboards API

Executor Configurations API

Provider Configurations API

Schema Registry API

OpenAPI Schemas API

XSD Schemas API

Webhooks API

Error handling

Trigger a Webhook (GET)

Authorizations

Headers

Path Parameters

Response