Webhook deliveries tools

`sendmock_webhook_delivery_cancel`

Stop the remaining retries.

Toolset webhooks.

Input	Type	Description
delivery_idrequired	string	The webhook delivery's ID, from `GET /api/v1/webhooks/deliveries`.Example: `01JB7T9Q2R5W8X3Y6Z1A4B7C9D`

Example call

{
  "name": "sendmock_webhook_delivery_cancel",
  "arguments": {
    "delivery_id": "01JB7T9Q2R5W8X3Y6Z1A4B7C9D"
  }
}

Result: WebhookDeliveryDetail

API: POST/api/v1/webhooks/deliveries/{deliveryId}/cancel
CLI: sendmock webhook deliveries cancel <deliveryId>
In the app: Webhooks > Deliveries > delivery > Cancel retries

`sendmock_webhook_delivery_get`

One delivery: request, response and every attempt.

Toolset webhooks.

Read only

Input	Type	Description
delivery_idrequired	string	The webhook delivery's ID, from `GET /api/v1/webhooks/deliveries`.Example: `01JB7T9Q2R5W8X3Y6Z1A4B7C9D`

Example call

{
  "name": "sendmock_webhook_delivery_get",
  "arguments": {
    "delivery_id": "01JB7T9Q2R5W8X3Y6Z1A4B7C9D"
  }
}

Result: WebhookDeliveryDetail

API: GET/api/v1/webhooks/deliveries/{deliveryId}
CLI: sendmock webhook deliveries show <deliveryId>
In the app: Webhooks > Deliveries > open a delivery

`sendmock_webhook_delivery_list`

Every webhook request sent, newest first.

Toolset webhooks.

Read only

Input	Type	Description
cursor	string	The next_cursor of the previous page.Example: `01JB7T9Q2R5W8X3Y6Z1A4B7C9D`
limit	integer	Items per page, 1 to 200 (default 50).Example: `50`
status	string	succeeded, failed or pending.Example: `failed`
endpoint_id	string	Only this endpoint.Example: `01JB7T9Q2R5W8X3Y6Z1A4B7C9D`
event_type	string	Only this event.One of: `email.received`, `email.inbound`, `email.opened`, `email.clicked`, `email.delivered`, `email.deferred`, `email.bounced`, `email.complained`, `email.unsubscribed`, `email.released`, `email.deleted`, `sms.sent`, `sms.status`, `sms.opened`, `sms.inbound`, `sms.reply_webhook`, `verify.started`, `verify.checked`, `verify.expired`, `push.sent`, `push.failed`, `http.captured`, `payment.created`, `payment.authorized`, `payment.succeeded`, `payment.failed`, `payment.canceled`, `payment.refunded`, `payment.partially_refunded`, `payment.dispute_opened`, `payment.dispute_updated`, `payment.dispute_closed`, `checkout.completed`, `checkout.expired`, `subscription.created`, `subscription.renewed`, `subscription.payment_failed`, `subscription.canceled`, `webhook.delivered`, `webhook.failed`, `test.ping`, `traffic.pruned`Example: `email.received`
subject_id	string	Only the deliveries an email, SMS or other message caused, by its ID.Example: `01JB7T9Q2R5W8X3Y6Z1A4B7C9E`

Example call

{
  "name": "sendmock_webhook_delivery_list",
  "arguments": {
    "cursor": "01JB7T9Q2R5W8X3Y6Z1A4B7C9D",
    "limit": 50
  }
}

Result: PageOf_WebhookDelivery

API: GET/api/v1/webhooks/deliveries
CLI: sendmock webhook deliveries list
In the app: Webhooks > Deliveries

`sendmock_webhook_delivery_replay`

Send the delivery again, as it was or edited.

Toolset webhooks.

Input	Type	Description
delivery_idrequired	string	The webhook delivery's ID, from `GET /api/v1/webhooks/deliveries`.Example: `01JB7T9Q2R5W8X3Y6Z1A4B7C9D`
rerenderrequired	boolean	Renders the request again with today's template and variables; false resends the stored request as it was.Example: `false`
body	string	An edited body and headers; left out to resend the stored request.Example: `{"type": "email.received"}`
headers	object	Edited headers, by name; left out to resend the stored ones.

Example call

{
  "name": "sendmock_webhook_delivery_replay",
  "arguments": {
    "delivery_id": "01JB7T9Q2R5W8X3Y6Z1A4B7C9D",
    "rerender": false,
    "body": "{\"type\": \"email.received\"}"
  }
}

Result: WebhookDelivery

API: POST/api/v1/webhooks/deliveries/{deliveryId}/replay
CLI: sendmock webhook deliveries replay <deliveryId>
In the app: Webhooks > Deliveries > delivery > Replay, Edit and replay

`sendmock_webhook_metrics`

Volume, success rate, latency and failures over a range.

Toolset webhooks.

Read only

Input	Type	Description
rangerequired	string	24h or 7d.One of: `24h`, `7d`Example: `24h`
endpoint_id	string	Only this endpoint.Example: `01JB7T9Q2R5W8X3Y6Z1A4B7C9D`

Example call

{
  "name": "sendmock_webhook_metrics",
  "arguments": {
    "range": "24h"
  }
}

Result: WebhookMetrics

API: GET/api/v1/webhooks/metrics
CLI: sendmock webhook metrics
In the app: Webhooks > Overview