Command reference
deployments webhook-delivery
Webhook delivery attempts
| Command | Summary |
|---|---|
deployments webhook-delivery list | List webhook deliveries |
deployments webhook-delivery show | Show a webhook delivery |
deployments webhook-delivery attempts | List the attempts of a webhook delivery |
deployments webhook-delivery retry | Retry a delivered or failed webhook delivery |
deployments webhook-delivery list
List webhook deliveries.
deployments webhook-delivery list- Calls
GET /v1/webhook-deliveries(SDKlistWebhookDeliveries). - Needs an environment:
--envor the saved context. - Paginated.
--page-sizesets the page size; pass the returned cursor as--cursorfor the next page.
| Flag | Type | Required | Default | Description |
|---|---|---|---|---|
--cursor | string (cursor) | Pagination cursor | ||
--page-size | string (number) | Page size | ||
--webhook | string | Webhook subscription ID | ||
--status | string | Delivery status: delivered, failed, pending, retrying, or sending |
Also accepts the global flags.
deployments webhook-delivery show
Show a webhook delivery.
deployments webhook-delivery show <id>- Calls
GET /v1/webhook-deliveries/{deliveryId}(SDKgetWebhookDelivery). - Needs an environment:
--envor the saved context.
| Flag | Type | Required | Default | Description |
|---|---|---|---|---|
<id> | positional | yes | Resource ID |
Also accepts the global flags.
deployments webhook-delivery attempts
List the attempts of a webhook delivery.
deployments webhook-delivery attempts <id>- Calls
GET /v1/webhook-deliveries/{deliveryId}/attempts(SDKlistWebhookDeliveryAttempts). - Needs an environment:
--envor the saved context. - Paginated.
--page-sizesets the page size; pass the returned cursor as--cursorfor the next page.
| Flag | Type | Required | Default | Description |
|---|---|---|---|---|
--cursor | string (cursor) | Pagination cursor | ||
--page-size | string (number) | Page size | ||
<id> | positional | yes | Resource ID |
Also accepts the global flags.
deployments webhook-delivery retry
Retry a delivered or failed webhook delivery.
deployments webhook-delivery retry <id>- Calls
POST /v1/webhook-deliveries/{deliveryId}/retry(SDKretryWebhookDelivery). - Needs an environment:
--envor the saved context.
| Flag | Type | Required | Default | Description |
|---|---|---|---|---|
<id> | positional | yes | Resource ID |
Also accepts the global flags.