FIfiles
site
Statuses

Test Webhook

Changed on

Test Webhook

post/site/test-webhook

Request

  • Base URL
    https://app.files.com/api/rest/v1
  • URL
    https://app.files.com/api/rest/v1/site/test-webhook
  • Auth
    none declared

Request body multipart/form-data

urlstring required

URL for testing the webhook.

methodstring

HTTP request method (GET or POST).

encodingstring

Encoding type for the webhook payload. Can be JSON, XML, or RAW (form data).

headersobject

Additional request headers to send via HTTP.

bodyobject

Additional body parameters to include in the webhook payload.

actionstring

Action for test body.

Example request

{
  "url": "https://www.site.com/...",
  "method": "GET",
  "encoding": "RAW",
  "headers": {
    "x-test-header": "testvalue"
  },
  "body": {
    "test-param": "testvalue"
  },
  "action": "test"
}

Response

The Behaviors object.

codeinteger

Status HTTP code

messagestring

Error message

statusstring

Status message

clickwrap_idinteger

Required Clickwrap id

clickwrap_bodystring

Required Clickwrap body

Example response

{
  "code": 200,
  "message": "example",
  "errors": [
    {
      "fields": [],
      "messages": []
    }
  ],
  "clickwrap_id": 1,
  "clickwrap_body": "example"
}

Changes