FIfiles
webhook_tests
Webhook Tests

Create Webhook Test

Changed on

Create Webhook Test

post/webhook_tests

Request

  • Base URL
    https://app.files.com/api/rest/v1
  • URL
    https://app.files.com/api/rest/v1/webhook_tests
  • Auth
    none declared

Request body multipart/form-data

urlstring required

URL for testing the webhook.

methodstring

HTTP method(GET or POST).

encodingstring

HTTP encoding method. Can be JSON, XML, or RAW (form data).

headersobject

Additional request headers.

bodyobject

Additional body parameters.

raw_bodystring

raw body text

file_as_bodyboolean

Send the file data as the request body?

file_form_fieldstring

Send the file data as a named parameter in the request POST body

actionstring

action for test body

use_dedicated_ipsboolean

Use dedicated IPs for sending the webhook?

Example request

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

Response

The WebhookTests object.

codeinteger

Status HTTP code

messagestring

Error message

statusstring

Status message

successboolean

The success status of the webhook test

Example response

{
  "code": 200,
  "success": true
}

Changes