← Back to documentation

HTTP Methods and Payload Formats

Understand how method and payload settings affect acceptance, validation, and forwarding.

7 min read

Use this guide to align sender requests with endpoint acceptance rules.

Purpose

This guide explains:

  • Endpoint method options.
  • Payload format handling.
  • Feature limits for no-body and text payload modes.

Prerequisites and permissions

  • Endpoint create/edit access.
  • Knowledge of sender method and content type.

Step-by-step workflow

1. Choose accepted HTTP method

Available values:

  • ANY
  • GET, POST, PUT, PATCH, DELETE, OPTIONS, HEAD, TRACE

Recommendation:

  • Use a specific method unless multi-method support is required.

2. Choose expected payload format

For body-capable methods (POST, PUT, PATCH, DELETE, OPTIONS, TRACE):

  • JSON (application/json)
  • XML (application/xml or text/xml)
  • FORM (application/x-www-form-urlencoded)
  • text/plain
  • None (ignore body) — the request body is completely ignored
  • Query Parameters — all URL query parameters are parsed as key-value pairs
  • Query Parameters (Base64 JSON) — a single query parameter containing a Base64-encoded JSON payload

For GET/HEAD:

  • None (ignore body) (default)
  • Query Parameters
  • Query Parameters (Base64 JSON)

3. Understand feature interactions

  • Field validation is disabled for text/plain and None formats.
  • Field validation works with Query Parameters and Query Parameters (Base64 JSON), including on GET/HEAD, since they parse to JSON.
  • Captcha requires a body-capable method plus JSON, FORM, or XML payload.
  • Method mismatches log METHOD_NOT_ALLOWED.
  • Content-type mismatches return unsupported media type.
  • None and query parameter formats accept any Content-Type header.

4. Using query parameter formats

See the Query Parameters guide for detailed usage.

4. Verify with sample traffic

  1. Send representative requests from sender.
  2. Confirm outcomes in Activity.
  3. Adjust endpoint config if sender behavior differs.

Expected result and verification checks

  • Incoming requests match configured method/content type.
  • Rejections are visible with explicit outcomes/errors.

Common issues and fixes

  • Sender posts while endpoint expects GET: align one side.
  • Wrong content type header: fix sender Content-Type.
  • Validation unexpectedly unavailable: check method + payload format.

Related guides

← Back to documentation