WebhookDelivery

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://artifacts.apis.io/artashippinginc/json-schema/artashippinginc-webhook-delivery-schema.json",
  "title": "WebhookDelivery",
  "x-generated": "2026-11-10",
  "x-method": "derived",
  "x-generator": "derive-json-schema.py",
  "x-source": "openapi/artashippinginc-webhook-deliveries-api-openapi.yml#/components/schemas/WebhookDelivery",
  "properties": {
    "created_at": {
      "readOnly": true,
      "type": "string",
      "x-struct": null,
      "x-validate": null
    },
    "id": {
      "description": "The string ID for this webhook delivery resource",
      "readOnly": true,
      "type": "string",
      "x-struct": null,
      "x-validate": null
    },
    "next_retry": {
      "description": "The UTC timestamp describing when a follow up webhook delivery event will be attempted if this one has failed",
      "readOnly": true,
      "type": [
        "string",
        "null"
      ],
      "x-struct": null,
      "x-validate": null
    },
    "request_body": {
      "description": "A stringified JSON representation of the data Arta sent to your endpoint",
      "readOnly": true,
      "type": "string",
      "x-struct": null,
      "x-validate": null
    },
    "resource_id": {
      "description": "The ID of the resource that triggered the webhook event",
      "readOnly": true,
      "type": "string",
      "x-struct": null,
      "x-validate": null
    },
    "resource_type": {
      "description": "The type of resource that triggered the webhook event",
      "enum": [
        "ping",
        "request",
        "shipment"
      ],
      "readOnly": true,
      "type": "string",
      "x-struct": null,
      "x-validate": null
    },
    "response_body": {
      "description": "A string representation of the response body Arta received from your endpoint",
      "readOnly": true,
      "type": "string",
      "x-struct": null,
      "x-validate": null
    },
    "response_status_code": {
      "description": "The numerical HTTP status code Arta received from your endpoint",
      "readOnly": true,
      "type": "number",
      "x-struct": null,
      "x-validate": null
    },
    "status": {
      "description": "The status of the webhook delivery event",
      "enum": [
        "delivered",
        "failed"
      ],
      "readOnly": true,
      "type": "string",
      "x-struct": null,
      "x-validate": null
    },
    "type": {
      "description": "The type of webhook delivery sent to your endpoint",
      "enum": [
        "ping",
        "request.created",
        "request.shared",
        "request.status.updated",
        "request.updated",
        "shipment.created",
        "shipment.eei_form_status.updated",
        "shipment.exceptions.updated",
        "shipment.schedule.updated",
        "shipment.status.updated",
        "shipment.tracking.updated",
        "shipment.updated",
        "shipment_exception.created",
        "shipment_exception.status.updated"
      ],
      "readOnly": true,
      "type": "string",
      "x-struct": null,
      "x-validate": null
    },
    "webhook_id": {
      "description": "The ID belonging to your webhook endpoint in Arta's system",
      "readOnly": true,
      "type": "integer",
      "x-struct": null,
      "x-validate": null
    },
    "webhook_url": {
      "description": "The URL belonging to your webhook endpoint in Arta's system at the time Arta attempted delivery of the webhook event",
      "readOnly": true,
      "type": "string",
      "x-struct": null,
      "x-validate": null
    }
  },
  "type": "object",
  "x-struct": "Elixir.DocsWeb.Schemas.Response.WebhookDelivery",
  "x-validate": null
}