Skip to main content

HTTP Request Worker

Handles outbound HTTP requests for webhooks and external API integrations.

Included in Base Preset

Registered automatically by registerBasePlugins() / registerAllPlugins().

Registration​

import { pluginRegistry } from '@unchainedshop/core';
import { HttpRequestPlugin } from '@unchainedshop/plugins/worker/http-request';

pluginRegistry.register(HttpRequestPlugin);

Usage​

Create HTTP request work:

mutation CreateWebhook {
addWork(
type: HTTP_REQUEST
input: {
url: "https://api.example.com/webhook"
method: "POST"
headers: { Authorization: "Bearer token" }
data: { event: "order.created", orderId: "123" }
}
) {
_id
status
}
}

Input Parameters​

ParameterTypeDescription
urlStringTarget URL (required)
methodStringHTTP method: GET or POST (default: POST)
headersObjectRequest headers
dataObjectRequest body for POST requests (JSON serialized, Content-Type: application/json)

The work item succeeds only on HTTP status 200; JSON responses are parsed, other responses are returned as { text }.

Adapter Details​

PropertyValue
Keyshop.unchained.worker-plugin.http-request
TypeHTTP_REQUEST
Sourceworker/http-request