Replay Webhook Delivery

POST /v1/webhooks/deliveries/{delivery_id}/replay

Authentication

Requires authentication via: OAuth2PasswordBearer.

Parameters

Name	In	Type	Required	Description	Constraints
delivery_id	path	string	Yes
X-API-Key	header	string | null	No		nullable

Responses

200

Successful Response

application/json

Resolved schema:

{
  "properties": {
    "id": {
      "type": "string",
      "title": "Id"
    },
    "endpoint_id": {
      "type": "string",
      "title": "Endpoint Id"
    },
    "user_id": {
      "type": "integer",
      "title": "User Id"
    },
    "event_id": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "title": "Event Id"
    },
    "event_type": {
      "type": "string",
      "title": "Event Type"
    },
    "event_group": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "title": "Event Group"
    },
    "status": {
      "type": "string",
      "title": "Status"
    },
    "scheduled_attempt": {
      "type": "integer",
      "title": "Scheduled Attempt"
    },
    "next_retry_at": {
      "anyOf": [
        {
          "type": "string",
          "format": "date-time"
        },
        {
          "type": "null"
        }
      ],
      "title": "Next Retry At"
    },
    "last_attempt_at": {
      "anyOf": [
        {
          "type": "string",
          "format": "date-time"
        },
        {
          "type": "null"
        }
      ],
      "title": "Last Attempt At"
    },
    "delivered_at": {
      "anyOf": [
        {
          "type": "string",
          "format": "date-time"
        },
        {
          "type": "null"
        }
      ],
      "title": "Delivered At"
    },
    "final_http_status": {
      "anyOf": [
        {
          "type": "integer"
        },
        {
          "type": "null"
        }
      ],
      "title": "Final Http Status"
    },
    "error_message": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "title": "Error Message"
    },
    "replay_of_delivery_id": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "title": "Replay Of Delivery Id"
    },
    "created_at": {
      "type": "string",
      "format": "date-time",
      "title": "Created At"
    },
    "updated_at": {
      "type": "string",
      "format": "date-time",
      "title": "Updated At"
    }
  },
  "type": "object",
  "required": [
    "id",
    "endpoint_id",
    "user_id",
    "event_type",
    "status",
    "scheduled_attempt",
    "created_at",
    "updated_at"
  ],
  "title": "WebhookDeliveryResponse"
}

Field details:

Field	Type	Required	Description	Constraints
id	string	Yes
endpoint_id	string	Yes
user_id	integer	Yes
event_id	string | null	No		nullable
event_type	string	Yes
event_group	string | null	No		nullable
status	string	Yes
scheduled_attempt	integer	Yes
next_retry_at	string | null	No		format=date-time, nullable
last_attempt_at	string | null	No		format=date-time, nullable
delivered_at	string | null	No		format=date-time, nullable
final_http_status	integer | null	No		nullable
error_message	string | null	No		nullable
replay_of_delivery_id	string | null	No		nullable
created_at	string	Yes		format=date-time
updated_at	string	Yes		format=date-time

422

Validation Error

application/json

Resolved schema:

{
  "properties": {
    "detail": {
      "items": {
        "properties": {
          "loc": {
            "items": {
              "anyOf": [
                {
                  "type": "string"
                },
                {
                  "type": "integer"
                }
              ]
            },
            "type": "array",
            "title": "Location"
          },
          "msg": {
            "type": "string",
            "title": "Message"
          },
          "type": {
            "type": "string",
            "title": "Error Type"
          }
        },
        "type": "object",
        "required": [
          "loc",
          "msg",
          "type"
        ],
        "title": "ValidationError"
      },
      "type": "array",
      "title": "Detail"
    }
  },
  "type": "object",
  "title": "HTTPValidationError"
}

Field details:

Field	Type	Required	Description	Constraints
detail	array<object>	No
detail[]	object	No
detail[].loc	array<string | integer>	No
detail[].loc[]	string | integer	No
detail[].msg	string	No
detail[].type	string	No