5.0.0 • Published 8 months ago
@xet/webhook-trigger v5.0.0
Trigger - Webhooks TELEPORT
Fires payload to endpoint.
Install
$ npm i @xet/webhook-triggerEnvironment variable
| Variable | Type | Required | Default | Description |
|---|---|---|---|---|
| TRIGGER_GOT_TIMEOUT | number | no | 10000 | The maximum allowed time for request |
| TRIGGER_GOT_RETRY_LIMIT | number | no | 1 | The maximum retry count |
| TRIGGER_GOT_BACKOFF_LIMIT | number | no | 3000 | The upper limit of the computedValue |
API
trigger(event, body, payload, hook): Object
| Name | Type | Description |
|---|---|---|
| event | string | Event name |
| body | object | Request body |
| payload | object | Payload data |
| hook | object | The hook ObjectId |
Response
| Name | Type | Description |
|---|---|---|
| status | number | HTTP response status code |
| message | string | HTTP response status message |
| sent | boolean | Success flag |
| headers | object | - |
| hash | string | - |
| hook | object | - |
| event | string | - |
| body | object | - |
| payload | object | - |