POST
/
image.errored
curl --request POST \
  --url https://your-webhook.com/image.errored \
  --header 'Content-Type: application/json' \
  --header 'magic-hour-event-signature: <magic-hour-event-signature>' \
  --header 'magic-hour-event-timestamp: <magic-hour-event-timestamp>' \
  --data '{
  "type": "image.errored",
  "payload": {
    "id": "clx7uu86w0a5qp55yxz315r6r",
    "name": "Example Name",
    "status": "complete",
    "image_count": 1,
    "type": "AI_HEADSHOT",
    "created_at": "2023-11-07T05:31:56Z",
    "enabled": true,
    "total_frame_cost": 5,
    "downloads": [
      {
        "url": "https://videos.magichour.ai/id/output.png",
        "expires_at": "2024-10-19T05:16:19.027Z"
      }
    ],
    "error": null
  }
}'
{
  "message": "Success message from your endpoint"
}

Headers

​
magic-hour-event-signature
string
required

A signatured created with the webhook secret key and a signed_payload, using HMAC with SHA-256

Example:

"3e771b50c..."

​
magic-hour-event-timestamp
string
required

Time in seconds since the epoch. Use this value to check whether the request is within a reasonable window of the current time. Usually less than 5 minutes.

Example:

"1730742038"

Body

application/json
Body
​
type
enum<string>
required
Available options:
image.errored
​
payload
object
required

Success

Response

200
application/json

Success

​
message
string
required
Example:

"Success message from your endpoint"

Was this page helpful?

Image CompletedVideo Started