API Reference

Visuals ready

wbhk
visualsReady

Sent when materials (visuals, documents, or other deliverables) are ready for download. On receipt, call the Materials API to retrieve the actual files.

Payload
const
enum
required
Allowed:
date-time
required

When the webhook was sent.

string
required
string
required
string
required

Resource type that is ready. Mirrors the platform resource taxonomy.

string
required

Product/deliverable that is ready. Mirrors the platform product taxonomy.

uuid

Real estate property id, if applicable.

string

Client-supplied object reference, if provided.

Headers
string
required

The event name. Matches the event field in the body.

Response
200

Acknowledged by the consumer.

Updated 3 days ago 

LoadingLoading…

Updated 3 days ago