Queues a signed webhook.test event for the webhook (whether or not it subscribed to it) and delivers it now. Use it to check an endpoint verifies the signature.
Usage
overlane webhook test webhook-id [--service URL] [--team TENANT_ID] [--dry-run]Arguments
| Argument | Required | Description |
|---|---|---|
webhook-id |
yes | The webhook ID from overlane webhook list |
Flags
| Flag | Type | Required | Default | Description |
|---|---|---|---|---|
--service |
string | no | The service address (default: OVERLANE_SERVICE_URL, then the project’s binding, then the hosted service) | |
--team |
string | no | The team (tenant) to act on (default: the one your token belongs to) | |
--dry-run |
boolean | no | Print the requests and file changes this command would make, then stop. Needs no credentials. |
Examples
overlane webhook test whk_0123456789abcdefBehavior
- Effect:
write(changes local or hosted state). - Needs credentials: yes. Uses the network: yes.
- Supports
--dry-run: yes. Accepts--force: no. - Machine-readable description:
overlane schema webhook test.
Result
With --json (the default when stdout is not a terminal) the command prints this JSON Schema’s shape on stdout.
{
"anyOf": [
{
"type": "object",
"properties": {
"tenantId": {
"type": "string"
},
"deliveries": {
"type": "array",
"items": {
"type": "object",
"properties": {
"eventId": {
"type": "string"
},
"sequence": {
"type": "number"
},
"type": {
"type": "string"
},
"status": {
"type": "string"
},
"attempts": {
"type": "number"
},
"nextAttemptAt": {
"type": [
"string",
"null"
]
},
"lastStatus": {
"type": [
"number",
"null"
]
}
},
"required": [
"eventId",
"sequence",
"type",
"status",
"attempts",
"nextAttemptAt",
"lastStatus"
],
"additionalProperties": false
}
},
"next": {
"type": "string"
}
},
"required": [
"tenantId",
"deliveries",
"next"
],
"additionalProperties": false
},
{
"type": "object",
"properties": {
"dryRun": {
"type": "boolean",
"const": true
},
"service": {
"type": "string"
},
"requests": {
"type": "array",
"items": {
"type": "object",
"properties": {
"method": {
"type": "string"
},
"path": {
"type": "string"
},
"body": {},
"note": {
"type": "string"
}
},
"required": [
"method",
"path"
],
"additionalProperties": false
}
},
"commands": {
"type": "array",
"items": {
"type": "string"
}
},
"writes": {
"type": "array",
"items": {
"type": "object",
"properties": {
"path": {
"type": "string"
},
"action": {
"type": "string",
"enum": [
"write",
"append",
"delete"
]
},
"description": {
"type": "string"
}
},
"required": [
"path",
"action",
"description"
],
"additionalProperties": false
}
},
"notes": {
"type": "array",
"items": {
"type": "string"
}
}
},
"required": [
"dryRun",
"requests",
"commands",
"writes",
"notes"
],
"additionalProperties": false
}
]
}See exit codes for the status the process returns.