Recent searches

in
Developer ReferenceAPI

Form Hooks

On this page

Update form hook

PUT/api/v0/form-hooks/{form_hook_uuid}
Path parameters:
form_hook_uuidUUIDRequired#
Request body:
explicitly_marked_statusenum#

Allowed values: no_mark spam ham

Example request:
Bash
Copied to clipboard
curl https://app.cloudcannon.com/api/v0/form-hooks/{form_hook_uuid} \
  -X PUT \
  -H "X-API-KEY: <your-api-key>" \
  -H "Content-Type: application/json" \
  -d '{
    "explicitly_marked_status": "no_mark"
  }'
Terminal
Responses:
200OK
JSON
Copied to clipboard
{
  "uuid": "00000000-0000-0000-0000-000000000000",
  "id": 0,
  "sent": true,
  "recaptcha": true,
  "ip": "string",
  "host": "string",
  "data": {},
  "timings": {},
  "error": "string",
  "explicitly_marked_status": "no_mark",
  "automatically_marked_spam": true,
  "last_sent_at": "2024-01-01T00:00:00Z",
  "cleared_at": "2024-01-01T00:00:00Z",
  "created_at": "2024-01-01T00:00:00Z",
  "updated_at": "2024-01-01T00:00:00Z",
  "inbox_uuid": "string",
  "site_uuid": "00000000-0000-0000-0000-000000000000"
}
Response
401Unauthorized
JSON
Copied to clipboard
{
  "error": "string"
}
Response
403Forbidden
JSON
Copied to clipboard
{
  "error": "string"
}
Response
422Unprocessable
JSON
Copied to clipboard
{
  "errors": {}
}
Response

Clear form hook

DELETE/api/v0/form-hooks/{form_hook_uuid}
Path parameters:
form_hook_uuidUUIDRequired#
Example request:
Bash
Copied to clipboard
curl https://app.cloudcannon.com/api/v0/form-hooks/{form_hook_uuid} \
  -X DELETE \
  -H "X-API-KEY: <your-api-key>"
Terminal
Responses:
200OK
JSON
Copied to clipboard
{
  "uuid": "00000000-0000-0000-0000-000000000000",
  "id": 0,
  "sent": true,
  "recaptcha": true,
  "ip": "string",
  "host": "string",
  "data": {},
  "timings": {},
  "error": "string",
  "explicitly_marked_status": "no_mark",
  "automatically_marked_spam": true,
  "last_sent_at": "2024-01-01T00:00:00Z",
  "cleared_at": "2024-01-01T00:00:00Z",
  "created_at": "2024-01-01T00:00:00Z",
  "updated_at": "2024-01-01T00:00:00Z",
  "inbox_uuid": "string",
  "site_uuid": "00000000-0000-0000-0000-000000000000"
}
Response
401Unauthorized
JSON
Copied to clipboard
{
  "error": "string"
}
Response
403Forbidden
JSON
Copied to clipboard
{
  "error": "string"
}
Response
422Unprocessable
JSON
Copied to clipboard
{
  "errors": {}
}
Response

Resend form hook

POST/api/v0/form-hooks/{form_hook_uuid}/send
Path parameters:
form_hook_uuidUUIDRequired#
Request body:
inbox_target_uuidUUID#
Example request:
Bash
Copied to clipboard
curl https://app.cloudcannon.com/api/v0/form-hooks/{form_hook_uuid}/send \
  -X POST \
  -H "X-API-KEY: <your-api-key>" \
  -H "Content-Type: application/json" \
  -d '{
    "inbox_target_uuid": "00000000-0000-0000-0000-000000000000"
  }'
Terminal
Responses:
204Queued
401Unauthorized
JSON
Copied to clipboard
{
  "error": "string"
}
Response
403Forbidden
JSON
Copied to clipboard
{
  "error": "string"
}
Response

List form hook sends

GET/api/v0/form-hooks/{form_hook_uuid}/sends
Path parameters:
form_hook_uuidUUIDRequired#
Query parameters:
created_at_gtstring#
created_at_gtestring#
created_at_ltstring#
created_at_ltestring#
form_hook_uuidstring#
idinteger#
inbox_target_uuidstring#
successboolean#
updated_at_gtstring#
updated_at_gtestring#
updated_at_ltstring#
updated_at_ltestring#
uuidstring#
searchstring#
Example request:
Bash
Copied to clipboard
curl https://app.cloudcannon.com/api/v0/form-hooks/{form_hook_uuid}/sends \
  -H "X-API-KEY: <your-api-key>"
Terminal
Responses:
200OK
JSON
Copied to clipboard
[
  {
    "uuid": "00000000-0000-0000-0000-000000000000",
    "id": 0,
    "created_at": "2024-01-01T00:00:00Z",
    "updated_at": "2024-01-01T00:00:00Z",
    "success": true,
    "error": "string",
    "inbox_target": {
      "uuid": "00000000-0000-0000-0000-000000000000",
      "id": 0,
      "target_type": "string",
      "target": "string",
      "validated": true,
      "config": {},
      "inbox_uuid": "00000000-0000-0000-0000-000000000000",
      "created_at": "2024-01-01T00:00:00Z",
      "updated_at": "2024-01-01T00:00:00Z"
    },
    "form_hook": {
      "uuid": "00000000-0000-0000-0000-000000000000",
      "id": 0,
      "sent": true,
      "recaptcha": true,
      "ip": "string",
      "host": "string",
      "data": {},
      "timings": {},
      "error": "string",
      "explicitly_marked_status": "no_mark",
      "automatically_marked_spam": true,
      "last_sent_at": "2024-01-01T00:00:00Z",
      "cleared_at": "2024-01-01T00:00:00Z",
      "created_at": "2024-01-01T00:00:00Z",
      "updated_at": "2024-01-01T00:00:00Z",
      "inbox_uuid": "string",
      "site_uuid": "00000000-0000-0000-0000-000000000000"
    }
  }
]
Response
401Unauthorized
JSON
Copied to clipboard
{
  "error": "string"
}
Response
403Forbidden
JSON
Copied to clipboard
{
  "error": "string"
}
Response
Open in a new tab