Image Started

Magic Hour notifies your server when an image project begins processing. Document signature headers, JSON schema, and example payload for image-generation webhooks.

POST /image.started

Image Started

cURL

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

200

{
  "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.started

payload · object · required

Success

Show child attributes

Response

200

application/json

Success

Success

message · string · required

Example:

"Success message from your endpoint"