Keyboard shortcuts

Press ← or → to navigate between chapters

Press S or / to search in the book

Press ? to show this help

Press Esc to hide this help

Form

Schemesform://, forms://
Cargo featureservice-form
Body formatstext, html, markdown (first is the default)
Attachmentsyes
Title length250 characters
Body length32,768 characters
Body linesunlimited
Request throttlenone
Vendor URLs acceptedno

URL formats

{schema}://{host}
{schema}://{host}:{port}
{schema}://{user}@{host}
{schema}://{user}@{host}:{port}
{schema}://{user}:{password}@{host}
{schema}://{user}:{password}@{host}:{port}

{schema} is one of form://, forms://.

URL tokens

TokenMeaningTypeRequiredDefaultNotes
{host}Hostnamestringyes
{password}Passwordstringnosecret
{port}Portint, 1 to 65535no
{user}Usernamestringno

Query parameters

ParameterMeaningTypeDefaultNotes
attach-asAttach File Asstringfile*
methodFetch MethodchoicePOSTone of POST, GET, DELETE, PUT, HEAD, PATCH, UPDATE, OPTIONS

Prefixed parameters:

  • +name=value: HTTP Header
  • -name=value: GET Params
  • :name=value: Payload Extras

The common URL parameters (format, overflow, verify, redirect, cto, rto, retry, wait, store, tag, tz, user, password, port, optional, emojis) apply as well.

Examples

Accepted URLs (tokens are fake):

form://localhost
forms://user:pass@localhost:8080/path/to/hook
form://localhost/?method=delete
form://localhost?attach-as=meta
form://localhost/?method=GET&-p=1
form://localhost/?+X-Custom=yes&-param=1&:title=subject&:message=&:extra=value

Rejected URLs:

form://localhost/?method=invalid
form://localhost?attach-as=!!!

Send one from the command line:

mercurio -t 'Backup' -b 'Finished in 42s' 'form://localhost'

Notes

Form webhook (form://, forms://): posts the notification as form fields (or multipart with attachments) to any HTTP endpoint.