Data export completedWebhook

SecuritySecretApiKey or JWT
Request
Request Body schema: application/json

Data export webhook body resource.

dataExportId
string

ID of the data export.

fileId
string

ID of the data export file.

eventType
string

Rebilly webhooks event type.

Value: "data-export-completed"
object
object (DataExport)
name
required
string

Name of the export.

format
required
string

Output format of the export.

Enum: "csv" "json" "json-api" "xml" "pdf"
resource
required
string

Type of resource to export.

id
string <= 50 characters

ID of the export.

object

Export request arguments used to filter and sort the result set. For more information, see Arguments.

emailNotification
Array of strings <email>

List of email addresses to notify when an export is completed.

fields
Array of strings

List of fields to include in the export. For more information, see Arguments.

object

Recurring export schedule.

userId
string

ID of the user who requested the data export.

recordCount
integer

Total number of records in the export, excluding the header row.

scheduledTime
string <date-time>

Date and time when the data export is scheduled to generate a file.

createdTime
string <date-time> (CreatedTime)

Date and time which is set automatically when the resource is created.

updatedTime
string <date-time> (UpdatedTime)

Date and time which updates automatically when the resource is updated.

status
string

Status of export request.

Enum: "pending" "queued" "processing" "completed"
Array of LinkSelf (object) or LinkUser (object) or LinkFileDownload (object) or LinkSignedLink (object) [ 1 .. 4 ] items

Related resource links.

object

Date range of the data export. If this value is not set, all data is included. For more information, see Date ranges.

Array of DataExportLink (object) or LinkFileDownload (object) >= 2 items

Related resource links.

Array (>= 2 items)
Any of:
rel
required
string

Type of link.

Value: "dataExport"
href
required
string

Link URL.

Responses
2xx

Returns any 2xx status to indicate that the data received.

Request samples
application/json
{
  • "dataExportId": "string",
  • "fileId": "string",
  • "eventType": "data-export-completed",
  • "_embedded": {
    },
  • "_links": [
    ]
}