Skip to main content
Loading...

API docs by

recording.created
Webhook

Request

recording.created events occur when a recording is created. Recordings are created when a file is uploaded, added to Edge Site storage, or created on a device that runs Foxlet.

Bodyapplication/jsonrequired
typestringrequired

The event type

Value:"recording.created"
timestampstring, (date-time)required

When the webhook event occurred

attemptedAtstring, (date-time)required

When the delivery was attempted

webhookEventIdstringrequired

ID of the associated webhook event

webhookIdstringrequired

ID of the webhook that notified your endpoint

recordingobjectrequired
projectIdstringrequired

The ID of the project this recording belongs to

POST
recording.created
Payload
{
  "type": "recording.created",
  "timestamp": "2019-08-24T14:15:22Z",
  "attemptedAt": "2019-08-24T14:15:22Z",
  "webhookEventId": "string",
  "webhookId": "string",
  "recording": {
    "id": "string",
    "key": "string",
    "sessionId": "string",
    "importStatus": "none",
    "path": "string",
    "location": { … },
    "device": { … },
    "edgeSite": { … },
    "site": { … }
  },
  "projectId": "string"
}

Responses

Return a 2XX status to acknowledge the event.