Sha256: b3a48efee727d251e3fbc8175dae6c57cea10846e7d3b1e41053a97f7a136c9f

Contents?: true

Size: 1.3 KB

Versions: 1

Compression:

Stored size: 1.3 KB

Contents

# WebhookTest

## Example WebhookTest Object

```
{
  "code": 200,
  "message": "",
  "status": "",
  "data": "",
  "success": true
}
```

* `code` (int64): Status HTTP code
* `message` (string): Error message
* `status` (string): Status message
* `data`: Additional data
* `success` (boolean): The success status of the webhook test
* `url` (string): URL for testing the webhook.
* `method` (string): HTTP method(GET or POST).
* `encoding` (string): HTTP encoding method.  Can be JSON, XML, or RAW (form data).
* `headers` (object): Additional request headers.
* `body` (object): Additional body parameters.
* `raw_body` (string): raw body text
* `action` (string): action for test body


---

## Create Webhook Test

```
Files::WebhookTest.create(
  url: "https://www.site.com/...", 
  method: "GET", 
  encoding: "RAW", 
  headers: "x-test-header => testvalue", 
  body: "test-param => testvalue", 
  raw_body: "test body", 
  action: "test"
)
```

### Parameters

* `url` (string): Required - URL for testing the webhook.
* `method` (string): HTTP method(GET or POST).
* `encoding` (string): HTTP encoding method.  Can be JSON, XML, or RAW (form data).
* `headers` (object): Additional request headers.
* `body` (object): Additional body parameters.
* `raw_body` (string): raw body text
* `action` (string): action for test body

Version data entries

1 entries across 1 versions & 1 rubygems

Version Path
files.com-1.0.191 docs/webhook_test.md