The action API

Purpose  

Sends a JSON message to any HTTP API endpoint. Use this action to integrate your scenario with external systems (webhooks, REST APIs, microservices) by POSTing structured JSON containing status, metadata or links to processed files. It is ideal for pushing events into business logic, triggering remote processing, or notifying other systems.

Where to add

Place this action wherever you need to call an external API: after file processing, conversion, notifications, or any step that produces metadata you want to send to another system.

Main settings

• Url
  The full endpoint URL to call (example: https://api.example.com/v1/ingest). Use HTTPS for secure transport. You can insert Fields to add dynamic path segments or query parameters.
• Add an authentification Header? (Authorization type and token)
  Enter the authorization scheme (example shows "Bearer").
  Paste the token or API key in the Api key field. At runtime the action will send an Authorization header.
  To use Basic auth, either supply "Basic" and a Base64-encoded credentials string, or add a custom header (see below). For OAuth flows that require token exchange, perform the exchange separately and use this action to post the received access token.
• Add a header value? (Custom header key/value)
  Use these fields to send additional HTTP headers required by the API (for example X-Request-Id, Accept, Content-Type override, or any vendor header). Examples:
  - Key: X-Request-Id, Value: 12345
• Message in JSON format
  The JSON payload that will be sent in the request body. Example: {"filename":"%FILENAME_FULL%","status":"processed"}
  - Use the Fields button to insert fields (dates, filenames, folder paths, metadata) so the payload is dynamic and contextual.

Behavior notes, request details and tips

• HTTP method: this action posts a JSON message (POST). 
• Content-Type: the action sends application/json by default. If the API expects a different content type, set a custom Content-Type header.
• Authentication: common pattern is Authorization: Bearer <token>. For other schemes (API key in header, custom header, or Basic auth) use the header fields to meet the API’s requirements.
• URL parameters: you may add query parameters directly in the URL or construct them with tokens (for example ?client=%CLIENT_ID%&date=%DATE%).
• File uploads: this action is for JSON messages only.

Security and compliance

• Protect API tokens and keys: treat the Api key and webhook/URL as secrets.
• Use HTTPS and validate certificates: ensure the endpoint uses TLS to protect data in transit.
• Avoid sending sensitive data unless allowed by policy: redact or omit confidential fields where required.

Examples

- Notify ingestion API

  - Url: https://api.partner.com/v1/notify  

  - Authorization: Bearer <token>  

  - JSON body:

{"filename":"%FILENAME_FULL%","status":"processed","size":%FILE_SIZE%,"processedAt":"%DATE_TIME%"}

Troubleshooting

• 401/403 Unauthorized: verify Authorization header format and token validity. Check whether the API requires additional scopes or IP allowlisting.  
• 400 Bad Request: inspect the JSON body for syntax errors or missing required fields; test with Postman to confirm expected schema.  
• 404 Not Found: confirm the full path and base URL are correct (watch for trailing slashes, version segments).  
• 5xx Server error: retry with exponential backoff or alert operators; server logs may provide details.  
• No network / TLS errors: ensure the host can resolve and reach the endpoint and that outbound HTTPS is allowed by firewall/proxy rules.

Best practices

• Build and test your JSON in Postman or RequestBin first.  
• Use meaningful tokens in payloads so downstream systems can process events reliably.  
• Keep payloads compact. For large data, send a link instead of embedding content.  

That’s it, provide the endpoint URL, configure Authorization and any extra headers, compose the JSON message (use Fields for dynamic content), and the HTTP Call Service action will POST the JSON to your API to integrate your automation with external business services.