Skip to main content
API docs by Redocly

Events (1.0.0)

Download OpenAPI specification:Download

Project

Created Webhook

A new project has been created

Request Body schema: application/json
required
type
required
string
Value: "Project.Created"
specversion
required
string
Value: "1.0"

The version of the CloudEvents specification which the event uses.

source
required
string

Identifies the context in which an event happened.

id
required
string

A unique identifier for the event.

sequence
required
number

A unique (when combined with source), monotonically increasing sequence number that starts with 0. It can be used to detect duplicate events..

time
required
string <date-time>

Timestamp of when the event happened.

data
required
object

The event payload.

customerId
required
string <uuid>
projectId
required
string <uuid>

Responses

Request samples

Content type
application/json
{
  • "type": "Project.Created",
  • "specversion": "1.0",
  • "source": "cloud.upowr.<env>",
  • "id": "string",
  • "sequence": 0,
  • "time": "2019-08-24T14:15:22Z",
  • "data": { },
  • "customerId": "87d8e330-2878-4742-a86f-dbbb3bf522ac",
  • "projectId": "5a8591dd-4039-49df-9202-96385ba3eff8"
}

ContractAccepted Webhook

The contract for a project has been accepted by the customer

Request Body schema: application/json
required
type
required
string
Value: "Project.ContractAccepted"
specversion
required
string
Value: "1.0"

The version of the CloudEvents specification which the event uses.

source
required
string

Identifies the context in which an event happened.

id
required
string

A unique identifier for the event.

sequence
required
number

A unique (when combined with source), monotonically increasing sequence number that starts with 0. It can be used to detect duplicate events..

time
required
string <date-time>

Timestamp of when the event happened.

required
object

The event payload.

customerId
required
string <uuid>
projectId
required
string <uuid>

Responses

Request samples

Content type
application/json
{
  • "type": "Project.ContractAccepted",
  • "specversion": "1.0",
  • "source": "cloud.upowr.<env>",
  • "id": "string",
  • "sequence": 0,
  • "time": "2019-08-24T14:15:22Z",
  • "data": {
    },
  • "customerId": "87d8e330-2878-4742-a86f-dbbb3bf522ac",
  • "projectId": "5a8591dd-4039-49df-9202-96385ba3eff8"
}

DepositPaid Webhook

The user has paid the deposit on a project

Request Body schema: application/json
required
type
required
string
Value: "Project.DepositPaid"
specversion
required
string
Value: "1.0"

The version of the CloudEvents specification which the event uses.

source
required
string

Identifies the context in which an event happened.

id
required
string

A unique identifier for the event.

sequence
required
number

A unique (when combined with source), monotonically increasing sequence number that starts with 0. It can be used to detect duplicate events..

time
required
string <date-time>

Timestamp of when the event happened.

required
object

The event payload.

customerId
required
string <uuid>
projectId
required
string <uuid>

Responses

Request samples

Content type
application/json
{
  • "type": "Project.DepositPaid",
  • "specversion": "1.0",
  • "source": "cloud.upowr.<env>",
  • "id": "string",
  • "sequence": 0,
  • "time": "2019-08-24T14:15:22Z",
  • "data": {
    },
  • "customerId": "87d8e330-2878-4742-a86f-dbbb3bf522ac",
  • "projectId": "5a8591dd-4039-49df-9202-96385ba3eff8"
}

FileAdded Webhook

A file has been added to a project

Request Body schema: application/json
required
type
required
string
Value: "Project.FileAdded"
specversion
required
string
Value: "1.0"

The version of the CloudEvents specification which the event uses.

source
required
string

Identifies the context in which an event happened.

id
required
string

A unique identifier for the event.

sequence
required
number

A unique (when combined with source), monotonically increasing sequence number that starts with 0. It can be used to detect duplicate events..

time
required
string <date-time>

Timestamp of when the event happened.

required
object

The event payload.

customerId
required
string <uuid>
projectId
required
string <uuid>

Responses

Request samples

Content type
application/json
{
  • "type": "Project.FileAdded",
  • "specversion": "1.0",
  • "source": "cloud.upowr.<env>",
  • "id": "string",
  • "sequence": 0,
  • "time": "2019-08-24T14:15:22Z",
  • "data": {
    },
  • "customerId": "87d8e330-2878-4742-a86f-dbbb3bf522ac",
  • "projectId": "5a8591dd-4039-49df-9202-96385ba3eff8"
}

Rejected Webhook

A project has been rejected

Request Body schema: application/json
required
type
required
string
Value: "Project.Rejected"
specversion
required
string
Value: "1.0"

The version of the CloudEvents specification which the event uses.

source
required
string

Identifies the context in which an event happened.

id
required
string

A unique identifier for the event.

sequence
required
number

A unique (when combined with source), monotonically increasing sequence number that starts with 0. It can be used to detect duplicate events..

time
required
string <date-time>

Timestamp of when the event happened.

required
object

The event payload.

customerId
required
string <uuid>
projectId
required
string <uuid>

Responses

Request samples

Content type
application/json
{
  • "type": "Project.Rejected",
  • "specversion": "1.0",
  • "source": "cloud.upowr.<env>",
  • "id": "string",
  • "sequence": 0,
  • "time": "2019-08-24T14:15:22Z",
  • "data": {
    },
  • "customerId": "87d8e330-2878-4742-a86f-dbbb3bf522ac",
  • "projectId": "5a8591dd-4039-49df-9202-96385ba3eff8"
}

StageChanged Webhook

A project has a new stage

Request Body schema: application/json
required
type
required
string
Value: "Project.StageChanged"
specversion
required
string
Value: "1.0"

The version of the CloudEvents specification which the event uses.

source
required
string

Identifies the context in which an event happened.

id
required
string

A unique identifier for the event.

sequence
required
number

A unique (when combined with source), monotonically increasing sequence number that starts with 0. It can be used to detect duplicate events..

time
required
string <date-time>

Timestamp of when the event happened.

required
object

The event payload.

customerId
required
string <uuid>
projectId
required
string <uuid>

Responses

Request samples

Content type
application/json
{
  • "type": "Project.StageChanged",
  • "specversion": "1.0",
  • "source": "cloud.upowr.<env>",
  • "id": "string",
  • "sequence": 0,
  • "time": "2019-08-24T14:15:22Z",
  • "data": {
    },
  • "customerId": "87d8e330-2878-4742-a86f-dbbb3bf522ac",
  • "projectId": "5a8591dd-4039-49df-9202-96385ba3eff8"
}

StateChanged Webhook

A project has a new state

Request Body schema: application/json
required
type
required
string
Value: "Project.StateChanged"
specversion
required
string
Value: "1.0"

The version of the CloudEvents specification which the event uses.

source
required
string

Identifies the context in which an event happened.

id
required
string

A unique identifier for the event.

sequence
required
number

A unique (when combined with source), monotonically increasing sequence number that starts with 0. It can be used to detect duplicate events..

time
required
string <date-time>

Timestamp of when the event happened.

required
object

The event payload.

customerId
required
string <uuid>
projectId
required
string <uuid>

Responses

Request samples

Content type
application/json
{
  • "type": "Project.StateChanged",
  • "specversion": "1.0",
  • "source": "cloud.upowr.<env>",
  • "id": "string",
  • "sequence": 0,
  • "time": "2019-08-24T14:15:22Z",
  • "data": {
    },
  • "customerId": "87d8e330-2878-4742-a86f-dbbb3bf522ac",
  • "projectId": "5a8591dd-4039-49df-9202-96385ba3eff8"
}

Site

AddressChanged Webhook

The address on a site has been changed

Request Body schema: application/json
required
type
required
string
Value: "Site.AddressChanged"
specversion
required
string
Value: "1.0"

The version of the CloudEvents specification which the event uses.

source
required
string

Identifies the context in which an event happened.

id
required
string

A unique identifier for the event.

sequence
required
number

A unique (when combined with source), monotonically increasing sequence number that starts with 0. It can be used to detect duplicate events..

time
required
string <date-time>

Timestamp of when the event happened.

required
object

The event payload.

customerId
required
string <uuid>

Responses

Request samples

Content type
application/json
{
  • "type": "Site.AddressChanged",
  • "specversion": "1.0",
  • "source": "cloud.upowr.<env>",
  • "id": "string",
  • "sequence": 0,
  • "time": "2019-08-24T14:15:22Z",
  • "data": {
    },
  • "customerId": "87d8e330-2878-4742-a86f-dbbb3bf522ac"
}

ContactChanged Webhook

The contact details on a site have been changed. Only used for commercial sites.

Request Body schema: application/json
required
type
required
string
Value: "Site.ContactChanged"
specversion
required
string
Value: "1.0"

The version of the CloudEvents specification which the event uses.

source
required
string

Identifies the context in which an event happened.

id
required
string

A unique identifier for the event.

sequence
required
number

A unique (when combined with source), monotonically increasing sequence number that starts with 0. It can be used to detect duplicate events..

time
required
string <date-time>

Timestamp of when the event happened.

required
object

The event payload.

customerId
required
string <uuid>

Responses

Request samples

Content type
application/json
{
  • "type": "Site.ContactChanged",
  • "specversion": "1.0",
  • "source": "cloud.upowr.<env>",
  • "id": "string",
  • "sequence": 0,
  • "time": "2019-08-24T14:15:22Z",
  • "data": {
    },
  • "customerId": "87d8e330-2878-4742-a86f-dbbb3bf522ac"
}

Created Webhook

A new Site has been created

Request Body schema: application/json
required
type
required
string
Value: "Site.Created"
specversion
required
string
Value: "1.0"

The version of the CloudEvents specification which the event uses.

source
required
string

Identifies the context in which an event happened.

id
required
string

A unique identifier for the event.

sequence
required
number

A unique (when combined with source), monotonically increasing sequence number that starts with 0. It can be used to detect duplicate events..

time
required
string <date-time>

Timestamp of when the event happened.

required
object

The event payload.

customerId
required
string <uuid>

Responses

Request samples

Content type
application/json
{
  • "type": "Site.Created",
  • "specversion": "1.0",
  • "source": "cloud.upowr.<env>",
  • "id": "string",
  • "sequence": 0,
  • "time": "2019-08-24T14:15:22Z",
  • "data": {
    },
  • "customerId": "87d8e330-2878-4742-a86f-dbbb3bf522ac"
}

Rejected Webhook

A site has been rejected

Request Body schema: application/json
required
type
required
string
Value: "Site.Rejected"
specversion
required
string
Value: "1.0"

The version of the CloudEvents specification which the event uses.

source
required
string

Identifies the context in which an event happened.

id
required
string

A unique identifier for the event.

sequence
required
number

A unique (when combined with source), monotonically increasing sequence number that starts with 0. It can be used to detect duplicate events..

time
required
string <date-time>

Timestamp of when the event happened.

required
object

The event payload.

customerId
required
string <uuid>

Responses

Request samples

Content type
application/json
{
  • "type": "Site.Rejected",
  • "specversion": "1.0",
  • "source": "cloud.upowr.<env>",
  • "id": "string",
  • "sequence": 0,
  • "time": "2019-08-24T14:15:22Z",
  • "data": {
    },
  • "customerId": "87d8e330-2878-4742-a86f-dbbb3bf522ac"
}

VppAssetDetailsConfirmed Webhook

The VPP asset details on a site have been confirmed

Request Body schema: application/json
required
type
required
string
Value: "Site.VppAssetDetailsConfirmed"
specversion
required
string
Value: "1.0"

The version of the CloudEvents specification which the event uses.

source
required
string

Identifies the context in which an event happened.

id
required
string

A unique identifier for the event.

sequence
required
number

A unique (when combined with source), monotonically increasing sequence number that starts with 0. It can be used to detect duplicate events..

time
required
string <date-time>

Timestamp of when the event happened.

required
object

The event payload.

customerId
required
string <uuid>

Responses

Request samples

Content type
application/json
{
  • "type": "Site.VppAssetDetailsConfirmed",
  • "specversion": "1.0",
  • "source": "cloud.upowr.<env>",
  • "id": "string",
  • "sequence": 0,
  • "time": "2019-08-24T14:15:22Z",
  • "data": {
    },
  • "customerId": "87d8e330-2878-4742-a86f-dbbb3bf522ac"
}

VppAssetOnboarded Webhook

The VPP asset has been onboarded

Request Body schema: application/json
required
type
required
string
Value: "Site.VppAssetOnboarded"
specversion
required
string
Value: "1.0"

The version of the CloudEvents specification which the event uses.

source
required
string

Identifies the context in which an event happened.

id
required
string

A unique identifier for the event.

sequence
required
number

A unique (when combined with source), monotonically increasing sequence number that starts with 0. It can be used to detect duplicate events..

time
required
string <date-time>

Timestamp of when the event happened.

required
object

The event payload.

customerId
required
string <uuid>

Responses

Request samples

Content type
application/json
{
  • "type": "Site.VppAssetOnboarded",
  • "specversion": "1.0",
  • "source": "cloud.upowr.<env>",
  • "id": "string",
  • "sequence": 0,
  • "time": "2019-08-24T14:15:22Z",
  • "data": {
    },
  • "customerId": "87d8e330-2878-4742-a86f-dbbb3bf522ac"
}

VppAssetRejected Webhook

The VPP asset has been rejected

Request Body schema: application/json
required
type
required
string
Value: "Site.VppAssetRejected"
specversion
required
string
Value: "1.0"

The version of the CloudEvents specification which the event uses.

source
required
string

Identifies the context in which an event happened.

id
required
string

A unique identifier for the event.

sequence
required
number

A unique (when combined with source), monotonically increasing sequence number that starts with 0. It can be used to detect duplicate events..

time
required
string <date-time>

Timestamp of when the event happened.

required
object

The event payload.

customerId
required
string <uuid>

Responses

Request samples

Content type
application/json
{
  • "type": "Site.VppAssetRejected",
  • "specversion": "1.0",
  • "source": "cloud.upowr.<env>",
  • "id": "string",
  • "sequence": 0,
  • "time": "2019-08-24T14:15:22Z",
  • "data": {
    },
  • "customerId": "87d8e330-2878-4742-a86f-dbbb3bf522ac"
}

Customer

Created Webhook

A new customer has been created

Request Body schema: application/json
required
type
required
string
Value: "Customer.Created"
specversion
required
string
Value: "1.0"

The version of the CloudEvents specification which the event uses.

source
required
string

Identifies the context in which an event happened.

id
required
string

A unique identifier for the event.

sequence
required
number

A unique (when combined with source), monotonically increasing sequence number that starts with 0. It can be used to detect duplicate events..

time
required
string <date-time>

Timestamp of when the event happened.

required
object

The event payload.

customerId
required
string <uuid>
projectId
required
string <uuid>

Responses

Request samples

Content type
application/json
{
  • "type": "Customer.Created",
  • "specversion": "1.0",
  • "source": "cloud.upowr.<env>",
  • "id": "string",
  • "sequence": 0,
  • "time": "2019-08-24T14:15:22Z",
  • "data": {
    },
  • "customerId": "87d8e330-2878-4742-a86f-dbbb3bf522ac",
  • "projectId": "5a8591dd-4039-49df-9202-96385ba3eff8"
}

ContactDetailsChanged Webhook

The name, email, mobile number, or mobile verification status of the customer has been changed

Request Body schema: application/json
required
type
required
string
Value: "Customer.ContactDetailsChanged"
specversion
required
string
Value: "1.0"

The version of the CloudEvents specification which the event uses.

source
required
string

Identifies the context in which an event happened.

id
required
string

A unique identifier for the event.

sequence
required
number

A unique (when combined with source), monotonically increasing sequence number that starts with 0. It can be used to detect duplicate events..

time
required
string <date-time>

Timestamp of when the event happened.

required
object

The event payload.

customerId
required
string <uuid>
projectId
required
string <uuid>

Responses

Request samples

Content type
application/json
{
  • "type": "Customer.ContactDetailsChanged",
  • "specversion": "1.0",
  • "source": "cloud.upowr.<env>",
  • "id": "string",
  • "sequence": 0,
  • "time": "2019-08-24T14:15:22Z",
  • "data": {
    },
  • "customerId": "87d8e330-2878-4742-a86f-dbbb3bf522ac",
  • "projectId": "5a8591dd-4039-49df-9202-96385ba3eff8"
}

PrimeContractorChanged Webhook

The prime contractor for a customer has been changed

Request Body schema: application/json
required
type
required
string
Value: "Customer.PrimeContractorChanged"
specversion
required
string
Value: "1.0"

The version of the CloudEvents specification which the event uses.

source
required
string

Identifies the context in which an event happened.

id
required
string

A unique identifier for the event.

sequence
required
number

A unique (when combined with source), monotonically increasing sequence number that starts with 0. It can be used to detect duplicate events..

time
required
string <date-time>

Timestamp of when the event happened.

required
object

The event payload.

customerId
required
string <uuid>
projectId
string <uuid>

Responses

Request samples

Content type
application/json
{
  • "type": "Customer.PrimeContractorChanged",
  • "specversion": "1.0",
  • "source": "cloud.upowr.<env>",
  • "id": "string",
  • "sequence": 0,
  • "time": "2019-08-24T14:15:22Z",
  • "data": {
    },
  • "customerId": "87d8e330-2878-4742-a86f-dbbb3bf522ac",
  • "projectId": "5a8591dd-4039-49df-9202-96385ba3eff8"
}

Job

Created Webhook

A new job has been created

Request Body schema: application/json
required
type
required
string
Value: "Job.Created"
specversion
required
string
Value: "1.0"

The version of the CloudEvents specification which the event uses.

source
required
string

Identifies the context in which an event happened.

id
required
string

A unique identifier for the event.

sequence
required
number

A unique (when combined with source), monotonically increasing sequence number that starts with 0. It can be used to detect duplicate events..

time
required
string <date-time>

Timestamp of when the event happened.

required
object

The event payload.

customerId
required
string <uuid>
projectId
required
string <uuid>

Responses

Request samples

Content type
application/json
{
  • "type": "Job.Created",
  • "specversion": "1.0",
  • "source": "cloud.upowr.<env>",
  • "id": "string",
  • "sequence": 0,
  • "time": "2019-08-24T14:15:22Z",
  • "data": {
    },
  • "customerId": "87d8e330-2878-4742-a86f-dbbb3bf522ac",
  • "projectId": "5a8591dd-4039-49df-9202-96385ba3eff8"
}

StateChanged Webhook

A job has a new state. NOTE: This event will fire even if the state is the same as it was before.

Request Body schema: application/json
required
type
required
string
Value: "Job.StateChanged"
specversion
required
string
Value: "1.0"

The version of the CloudEvents specification which the event uses.

source
required
string

Identifies the context in which an event happened.

id
required
string

A unique identifier for the event.

sequence
required
number

A unique (when combined with source), monotonically increasing sequence number that starts with 0. It can be used to detect duplicate events..

time
required
string <date-time>

Timestamp of when the event happened.

required
object

The event payload.

customerId
required
string <uuid>
projectId
required
string <uuid>

Responses

Request samples

Content type
application/json
{
  • "type": "Job.StateChanged",
  • "specversion": "1.0",
  • "source": "cloud.upowr.<env>",
  • "id": "string",
  • "sequence": 0,
  • "time": "2019-08-24T14:15:22Z",
  • "data": {
    },
  • "customerId": "87d8e330-2878-4742-a86f-dbbb3bf522ac",
  • "projectId": "5a8591dd-4039-49df-9202-96385ba3eff8"
}

Assigned Webhook

A job has been assigned to an installer company

Request Body schema: application/json
required
type
required
string
Value: "Job.Assigned"
specversion
required
string
Value: "1.0"

The version of the CloudEvents specification which the event uses.

source
required
string

Identifies the context in which an event happened.

id
required
string

A unique identifier for the event.

sequence
required
number

A unique (when combined with source), monotonically increasing sequence number that starts with 0. It can be used to detect duplicate events..

time
required
string <date-time>

Timestamp of when the event happened.

required
object

The event payload.

customerId
required
string <uuid>
projectId
required
string <uuid>

Responses

Request samples

Content type
application/json
{
  • "type": "Job.Assigned",
  • "specversion": "1.0",
  • "source": "cloud.upowr.<env>",
  • "id": "string",
  • "sequence": 0,
  • "time": "2019-08-24T14:15:22Z",
  • "data": {
    },
  • "customerId": "87d8e330-2878-4742-a86f-dbbb3bf522ac",
  • "projectId": "5a8591dd-4039-49df-9202-96385ba3eff8"
}

Unassigned Webhook

A job has been unassigned from an installer company

Request Body schema: application/json
required
type
required
string
Value: "Job.Unassigned"
specversion
required
string
Value: "1.0"

The version of the CloudEvents specification which the event uses.

source
required
string

Identifies the context in which an event happened.

id
required
string

A unique identifier for the event.

sequence
required
number

A unique (when combined with source), monotonically increasing sequence number that starts with 0. It can be used to detect duplicate events..

time
required
string <date-time>

Timestamp of when the event happened.

required
object

The event payload.

customerId
required
string <uuid>
projectId
required
string <uuid>

Responses

Request samples

Content type
application/json
{
  • "type": "Job.Unassigned",
  • "specversion": "1.0",
  • "source": "cloud.upowr.<env>",
  • "id": "string",
  • "sequence": 0,
  • "time": "2019-08-24T14:15:22Z",
  • "data": {
    },
  • "customerId": "87d8e330-2878-4742-a86f-dbbb3bf522ac",
  • "projectId": "5a8591dd-4039-49df-9202-96385ba3eff8"
}

Scheduled Webhook

A job has been scheduled by the installer. NOTE: Jobs can be scheduled when they are accepted. In those cases this event will not fire

Request Body schema: application/json
required
type
required
string
Value: "Job.Scheduled"
specversion
required
string
Value: "1.0"

The version of the CloudEvents specification which the event uses.

source
required
string

Identifies the context in which an event happened.

id
required
string

A unique identifier for the event.

sequence
required
number

A unique (when combined with source), monotonically increasing sequence number that starts with 0. It can be used to detect duplicate events..

time
required
string <date-time>

Timestamp of when the event happened.

required
object

The event payload.

customerId
required
string <uuid>
projectId
required
string <uuid>

Responses

Request samples

Content type
application/json
{
  • "type": "Job.Scheduled",
  • "specversion": "1.0",
  • "source": "cloud.upowr.<env>",
  • "id": "string",
  • "sequence": 0,
  • "time": "2019-08-24T14:15:22Z",
  • "data": {
    },
  • "customerId": "87d8e330-2878-4742-a86f-dbbb3bf522ac",
  • "projectId": "5a8591dd-4039-49df-9202-96385ba3eff8"
}

Accepted Webhook

A job has been accepted by the installer

Request Body schema: application/json
required
type
required
string
Value: "Job.Accepted"
specversion
required
string
Value: "1.0"

The version of the CloudEvents specification which the event uses.

source
required
string

Identifies the context in which an event happened.

id
required
string

A unique identifier for the event.

sequence
required
number

A unique (when combined with source), monotonically increasing sequence number that starts with 0. It can be used to detect duplicate events..

time
required
string <date-time>

Timestamp of when the event happened.

required
object

The event payload.

customerId
required
string <uuid>
projectId
required
string <uuid>

Responses

Request samples

Content type
application/json
{
  • "type": "Job.Accepted",
  • "specversion": "1.0",
  • "source": "cloud.upowr.<env>",
  • "id": "string",
  • "sequence": 0,
  • "time": "2019-08-24T14:15:22Z",
  • "data": {
    },
  • "customerId": "87d8e330-2878-4742-a86f-dbbb3bf522ac",
  • "projectId": "5a8591dd-4039-49df-9202-96385ba3eff8"
}

Confirmed Webhook

A job has been confirmed by the installer

Request Body schema: application/json
required
type
required
string
Value: "Job.Confirmed"
specversion
required
string
Value: "1.0"

The version of the CloudEvents specification which the event uses.

source
required
string

Identifies the context in which an event happened.

id
required
string

A unique identifier for the event.

sequence
required
number

A unique (when combined with source), monotonically increasing sequence number that starts with 0. It can be used to detect duplicate events..

time
required
string <date-time>

Timestamp of when the event happened.

required
object

The event payload.

customerId
required
string <uuid>
projectId
required
string <uuid>

Responses

Request samples

Content type
application/json
{
  • "type": "Job.Confirmed",
  • "specversion": "1.0",
  • "source": "cloud.upowr.<env>",
  • "id": "string",
  • "sequence": 0,
  • "time": "2019-08-24T14:15:22Z",
  • "data": {
    },
  • "customerId": "87d8e330-2878-4742-a86f-dbbb3bf522ac",
  • "projectId": "5a8591dd-4039-49df-9202-96385ba3eff8"
}

Rescheduled Webhook

A job has been rescheduled by the installer

Request Body schema: application/json
required
type
required
string
Value: "Job.Rescheduled"
specversion
required
string
Value: "1.0"

The version of the CloudEvents specification which the event uses.

source
required
string

Identifies the context in which an event happened.

id
required
string

A unique identifier for the event.

sequence
required
number

A unique (when combined with source), monotonically increasing sequence number that starts with 0. It can be used to detect duplicate events..

time
required
string <date-time>

Timestamp of when the event happened.

required
object

The event payload.

customerId
required
string <uuid>
projectId
required
string <uuid>

Responses

Request samples

Content type
application/json
{
  • "type": "Job.Rescheduled",
  • "specversion": "1.0",
  • "source": "cloud.upowr.<env>",
  • "id": "string",
  • "sequence": 0,
  • "time": "2019-08-24T14:15:22Z",
  • "data": {
    },
  • "customerId": "87d8e330-2878-4742-a86f-dbbb3bf522ac",
  • "projectId": "5a8591dd-4039-49df-9202-96385ba3eff8"
}

Rejected Webhook

A job has been rejected by the installer

Request Body schema: application/json
required
type
required
string
Value: "Job.Rejected"
specversion
required
string
Value: "1.0"

The version of the CloudEvents specification which the event uses.

source
required
string

Identifies the context in which an event happened.

id
required
string

A unique identifier for the event.

sequence
required
number

A unique (when combined with source), monotonically increasing sequence number that starts with 0. It can be used to detect duplicate events..

time
required
string <date-time>

Timestamp of when the event happened.

required
object

The event payload.

customerId
required
string <uuid>
projectId
required
string <uuid>

Responses

Request samples

Content type
application/json
{
  • "type": "Job.Rejected",
  • "specversion": "1.0",
  • "source": "cloud.upowr.<env>",
  • "id": "string",
  • "sequence": 0,
  • "time": "2019-08-24T14:15:22Z",
  • "data": {
    },
  • "customerId": "87d8e330-2878-4742-a86f-dbbb3bf522ac",
  • "projectId": "5a8591dd-4039-49df-9202-96385ba3eff8"
}

Cancelled Webhook

A job has been cancelled

Request Body schema: application/json
required
type
required
string
Value: "Job.Cancelled"
specversion
required
string
Value: "1.0"

The version of the CloudEvents specification which the event uses.

source
required
string

Identifies the context in which an event happened.

id
required
string

A unique identifier for the event.

sequence
required
number

A unique (when combined with source), monotonically increasing sequence number that starts with 0. It can be used to detect duplicate events..

time
required
string <date-time>

Timestamp of when the event happened.

required
object

The event payload.

customerId
required
string <uuid>
projectId
required
string <uuid>

Responses

Request samples

Content type
application/json
{
  • "type": "Job.Cancelled",
  • "specversion": "1.0",
  • "source": "cloud.upowr.<env>",
  • "id": "string",
  • "sequence": 0,
  • "time": "2019-08-24T14:15:22Z",
  • "data": {
    },
  • "customerId": "87d8e330-2878-4742-a86f-dbbb3bf522ac",
  • "projectId": "5a8591dd-4039-49df-9202-96385ba3eff8"
}

Completed Webhook

A new job has been completed

Request Body schema: application/json
required
type
required
string
Value: "Job.Completed"
specversion
required
string
Value: "1.0"

The version of the CloudEvents specification which the event uses.

source
required
string

Identifies the context in which an event happened.

id
required
string

A unique identifier for the event.

sequence
required
number

A unique (when combined with source), monotonically increasing sequence number that starts with 0. It can be used to detect duplicate events..

time
required
string <date-time>

Timestamp of when the event happened.

required
object

The event payload.

customerId
required
string <uuid>
projectId
required
string <uuid>

Responses

Request samples

Content type
application/json
{
  • "type": "Job.Completed",
  • "specversion": "1.0",
  • "source": "cloud.upowr.<env>",
  • "id": "string",
  • "sequence": 0,
  • "time": "2019-08-24T14:15:22Z",
  • "data": {
    },
  • "customerId": "87d8e330-2878-4742-a86f-dbbb3bf522ac",
  • "projectId": "5a8591dd-4039-49df-9202-96385ba3eff8"
}

FileAdded Webhook

A file has been added to a job

Request Body schema: application/json
required
type
required
string
Value: "Job.FileAdded"
specversion
required
string
Value: "1.0"

The version of the CloudEvents specification which the event uses.

source
required
string

Identifies the context in which an event happened.

id
required
string

A unique identifier for the event.

sequence
required
number

A unique (when combined with source), monotonically increasing sequence number that starts with 0. It can be used to detect duplicate events..

time
required
string <date-time>

Timestamp of when the event happened.

required
object

The event payload.

customerId
required
string <uuid>
projectId
required
string <uuid>

Responses

Request samples

Content type
application/json
{
  • "type": "Job.FileAdded",
  • "specversion": "1.0",
  • "source": "cloud.upowr.<env>",
  • "id": "string",
  • "sequence": 0,
  • "time": "2019-08-24T14:15:22Z",
  • "data": {
    },
  • "customerId": "87d8e330-2878-4742-a86f-dbbb3bf522ac",
  • "projectId": "5a8591dd-4039-49df-9202-96385ba3eff8"
}

InstallerTaskSubmitted Webhook

The installer has submitted a task on a job

Request Body schema: application/json
required
type
required
string
Value: "Job.InstallerTaskSubmitted"
specversion
required
string
Value: "1.0"

The version of the CloudEvents specification which the event uses.

source
required
string

Identifies the context in which an event happened.

id
required
string

A unique identifier for the event.

sequence
required
number

A unique (when combined with source), monotonically increasing sequence number that starts with 0. It can be used to detect duplicate events..

time
required
string <date-time>

Timestamp of when the event happened.

required
object

The event payload.

customerId
required
string <uuid>
projectId
required
string <uuid>

Responses

Request samples

Content type
application/json
{
  • "type": "Job.InstallerTaskSubmitted",
  • "specversion": "1.0",
  • "source": "cloud.upowr.<env>",
  • "id": "string",
  • "sequence": 0,
  • "time": "2019-08-24T14:15:22Z",
  • "data": {
    },
  • "customerId": "87d8e330-2878-4742-a86f-dbbb3bf522ac",
  • "projectId": "5a8591dd-4039-49df-9202-96385ba3eff8"
}

Submitted Webhook

The installer has submitted all tasks on a job

Request Body schema: application/json
required
type
required
string
Value: "Job.Submitted"
specversion
required
string
Value: "1.0"

The version of the CloudEvents specification which the event uses.

source
required
string

Identifies the context in which an event happened.

id
required
string

A unique identifier for the event.

sequence
required
number

A unique (when combined with source), monotonically increasing sequence number that starts with 0. It can be used to detect duplicate events..

time
required
string <date-time>

Timestamp of when the event happened.

required
object

The event payload.

customerId
required
string <uuid>
projectId
required
string <uuid>

Responses

Request samples

Content type
application/json
{
  • "type": "Job.Submitted",
  • "specversion": "1.0",
  • "source": "cloud.upowr.<env>",
  • "id": "string",
  • "sequence": 0,
  • "time": "2019-08-24T14:15:22Z",
  • "data": {
    },
  • "customerId": "87d8e330-2878-4742-a86f-dbbb3bf522ac",
  • "projectId": "5a8591dd-4039-49df-9202-96385ba3eff8"
}

Reviewed Webhook

A review has been added to a job

Request Body schema: application/json
required
type
required
string
Value: "Job.Reviewed"
specversion
required
string
Value: "1.0"

The version of the CloudEvents specification which the event uses.

source
required
string

Identifies the context in which an event happened.

id
required
string

A unique identifier for the event.

sequence
required
number

A unique (when combined with source), monotonically increasing sequence number that starts with 0. It can be used to detect duplicate events..

time
required
string <date-time>

Timestamp of when the event happened.

required
object

The event payload.

customerId
required
string <uuid>
projectId
required
string <uuid>

Responses

Request samples

Content type
application/json
{
  • "type": "Job.Reviewed",
  • "specversion": "1.0",
  • "source": "cloud.upowr.<env>",
  • "id": "string",
  • "sequence": 0,
  • "time": "2019-08-24T14:15:22Z",
  • "data": {
    },
  • "customerId": "87d8e330-2878-4742-a86f-dbbb3bf522ac",
  • "projectId": "5a8591dd-4039-49df-9202-96385ba3eff8"
}

WeatherForecastAdded Webhook

A weather forecast has been added to a job

Request Body schema: application/json
required
type
required
string
Value: "Job.WeatherForecastAdded"
specversion
required
string
Value: "1.0"

The version of the CloudEvents specification which the event uses.

source
required
string

Identifies the context in which an event happened.

id
required
string

A unique identifier for the event.

sequence
required
number

A unique (when combined with source), monotonically increasing sequence number that starts with 0. It can be used to detect duplicate events..

time
required
string <date-time>

Timestamp of when the event happened.

required
object

The event payload.

customerId
required
string <uuid>
projectId
required
string <uuid>

Responses

Request samples

Content type
application/json
{
  • "type": "Job.WeatherForecastAdded",
  • "specversion": "1.0",
  • "source": "cloud.upowr.<env>",
  • "id": "string",
  • "sequence": 0,
  • "time": "2019-08-24T14:15:22Z",
  • "data": {
    },
  • "customerId": "87d8e330-2878-4742-a86f-dbbb3bf522ac",
  • "projectId": "5a8591dd-4039-49df-9202-96385ba3eff8"
}

Quote

Created Webhook

A new quote has been created

Request Body schema: application/json
required
type
required
string
Value: "Quote.Created"
specversion
required
string
Value: "1.0"

The version of the CloudEvents specification which the event uses.

source
required
string

Identifies the context in which an event happened.

id
required
string

A unique identifier for the event.

sequence
required
number

A unique (when combined with source), monotonically increasing sequence number that starts with 0. It can be used to detect duplicate events..

time
required
string <date-time>

Timestamp of when the event happened.

required
object

The event payload.

customerId
required
string <uuid>
projectId
required
string <uuid>

Responses

Request samples

Content type
application/json
{
  • "type": "Quote.Created",
  • "specversion": "1.0",
  • "source": "cloud.upowr.<env>",
  • "id": "string",
  • "sequence": 0,
  • "time": "2019-08-24T14:15:22Z",
  • "data": {
    },
  • "customerId": "87d8e330-2878-4742-a86f-dbbb3bf522ac",
  • "projectId": "5a8591dd-4039-49df-9202-96385ba3eff8"
}

StateChanged Webhook

A quote has a new state.

Request Body schema: application/json
required
type
required
string
Value: "Quote.StateChanged"
specversion
required
string
Value: "1.0"

The version of the CloudEvents specification which the event uses.

source
required
string

Identifies the context in which an event happened.

id
required
string

A unique identifier for the event.

sequence
required
number

A unique (when combined with source), monotonically increasing sequence number that starts with 0. It can be used to detect duplicate events..

time
required
string <date-time>

Timestamp of when the event happened.

required
object

The event payload.

customerId
required
string <uuid>
projectId
required
string <uuid>

Responses

Request samples

Content type
application/json
{
  • "type": "Quote.StateChanged",
  • "specversion": "1.0",
  • "source": "cloud.upowr.<env>",
  • "id": "string",
  • "sequence": 0,
  • "time": "2019-08-24T14:15:22Z",
  • "data": {
    },
  • "customerId": "87d8e330-2878-4742-a86f-dbbb3bf522ac",
  • "projectId": "5a8591dd-4039-49df-9202-96385ba3eff8"
}

FileAdded Webhook

A file has been added to a quote

Request Body schema: application/json
required
type
required
string
Value: "Quote.FileAdded"
specversion
required
string
Value: "1.0"

The version of the CloudEvents specification which the event uses.

source
required
string

Identifies the context in which an event happened.

id
required
string

A unique identifier for the event.

sequence
required
number

A unique (when combined with source), monotonically increasing sequence number that starts with 0. It can be used to detect duplicate events..

time
required
string <date-time>

Timestamp of when the event happened.

required
object

The event payload.

customerId
required
string <uuid>
projectId
required
string <uuid>

Responses

Request samples

Content type
application/json
{
  • "type": "Quote.FileAdded",
  • "specversion": "1.0",
  • "source": "cloud.upowr.<env>",
  • "id": "string",
  • "sequence": 0,
  • "time": "2019-08-24T14:15:22Z",
  • "data": {
    },
  • "customerId": "87d8e330-2878-4742-a86f-dbbb3bf522ac",
  • "projectId": "5a8591dd-4039-49df-9202-96385ba3eff8"
}

Accepted Webhook

A quote has been accepted

Request Body schema: application/json
required
type
required
string
Value: "Quote.Accepted"
specversion
required
string
Value: "1.0"

The version of the CloudEvents specification which the event uses.

source
required
string

Identifies the context in which an event happened.

id
required
string

A unique identifier for the event.

sequence
required
number

A unique (when combined with source), monotonically increasing sequence number that starts with 0. It can be used to detect duplicate events..

time
required
string <date-time>

Timestamp of when the event happened.

required
object

The event payload.

customerId
required
string <uuid>
projectId
required
string <uuid>

Responses

Request samples

Content type
application/json
{
  • "type": "Quote.Accepted",
  • "specversion": "1.0",
  • "source": "cloud.upowr.<env>",
  • "id": "string",
  • "sequence": 0,
  • "time": "2019-08-24T14:15:22Z",
  • "data": {
    },
  • "customerId": "87d8e330-2878-4742-a86f-dbbb3bf522ac",
  • "projectId": "5a8591dd-4039-49df-9202-96385ba3eff8"
}

Published Webhook

A quote has been published

Request Body schema: application/json
required
type
required
string
Value: "Quote.Published"
specversion
required
string
Value: "1.0"

The version of the CloudEvents specification which the event uses.

source
required
string

Identifies the context in which an event happened.

id
required
string

A unique identifier for the event.

sequence
required
number

A unique (when combined with source), monotonically increasing sequence number that starts with 0. It can be used to detect duplicate events..

time
required
string <date-time>

Timestamp of when the event happened.

required
object

The event payload.

customerId
required
string <uuid>
projectId
required
string <uuid>

Responses

Request samples

Content type
application/json
{
  • "type": "Quote.Published",
  • "specversion": "1.0",
  • "source": "cloud.upowr.<env>",
  • "id": "string",
  • "sequence": 0,
  • "time": "2019-08-24T14:15:22Z",
  • "data": {
    },
  • "customerId": "87d8e330-2878-4742-a86f-dbbb3bf522ac",
  • "projectId": "5a8591dd-4039-49df-9202-96385ba3eff8"
}

Rejected Webhook

A quote has been rejected

Request Body schema: application/json
required
type
required
string
Value: "Quote.Rejected"
specversion
required
string
Value: "1.0"

The version of the CloudEvents specification which the event uses.

source
required
string

Identifies the context in which an event happened.

id
required
string

A unique identifier for the event.

sequence
required
number

A unique (when combined with source), monotonically increasing sequence number that starts with 0. It can be used to detect duplicate events..

time
required
string <date-time>

Timestamp of when the event happened.

required
object

The event payload.

customerId
required
string <uuid>
projectId
required
string <uuid>

Responses

Request samples

Content type
application/json
{
  • "type": "Quote.Rejected",
  • "specversion": "1.0",
  • "source": "cloud.upowr.<env>",
  • "id": "string",
  • "sequence": 0,
  • "time": "2019-08-24T14:15:22Z",
  • "data": {
    },
  • "customerId": "87d8e330-2878-4742-a86f-dbbb3bf522ac",
  • "projectId": "5a8591dd-4039-49df-9202-96385ba3eff8"
}

Voided Webhook

A quote has been voided

Request Body schema: application/json
required
type
required
string
Value: "Quote.Voided"
specversion
required
string
Value: "1.0"

The version of the CloudEvents specification which the event uses.

source
required
string

Identifies the context in which an event happened.

id
required
string

A unique identifier for the event.

sequence
required
number

A unique (when combined with source), monotonically increasing sequence number that starts with 0. It can be used to detect duplicate events..

time
required
string <date-time>

Timestamp of when the event happened.

required
object

The event payload.

customerId
required
string <uuid>
projectId
required
string <uuid>

Responses

Request samples

Content type
application/json
{
  • "type": "Quote.Voided",
  • "specversion": "1.0",
  • "source": "cloud.upowr.<env>",
  • "id": "string",
  • "sequence": 0,
  • "time": "2019-08-24T14:15:22Z",
  • "data": {
    },
  • "customerId": "87d8e330-2878-4742-a86f-dbbb3bf522ac",
  • "projectId": "5a8591dd-4039-49df-9202-96385ba3eff8"
}

DiscountChanged Webhook

The discount on a quote has been changed

Request Body schema: application/json
required
type
required
string
Value: "Quote.DiscountChanged"
specversion
required
string
Value: "1.0"

The version of the CloudEvents specification which the event uses.

source
required
string

Identifies the context in which an event happened.

id
required
string

A unique identifier for the event.

sequence
required
number

A unique (when combined with source), monotonically increasing sequence number that starts with 0. It can be used to detect duplicate events..

time
required
string <date-time>

Timestamp of when the event happened.

required
object

The event payload.

customerId
required
string <uuid>
projectId
required
string <uuid>

Responses

Request samples

Content type
application/json
{
  • "type": "Quote.DiscountChanged",
  • "specversion": "1.0",
  • "source": "cloud.upowr.<env>",
  • "id": "string",
  • "sequence": 0,
  • "time": "2019-08-24T14:15:22Z",
  • "data": {
    },
  • "customerId": "87d8e330-2878-4742-a86f-dbbb3bf522ac",
  • "projectId": "5a8591dd-4039-49df-9202-96385ba3eff8"
}

ItemsUpdated Webhook

The items on a quote have been updated

Request Body schema: application/json
required
type
required
string
Value: "Quote.ItemsUpdated"
specversion
required
string
Value: "1.0"

The version of the CloudEvents specification which the event uses.

source
required
string

Identifies the context in which an event happened.

id
required
string

A unique identifier for the event.

sequence
required
number

A unique (when combined with source), monotonically increasing sequence number that starts with 0. It can be used to detect duplicate events..

time
required
string <date-time>

Timestamp of when the event happened.

required
object

The event payload.

customerId
required
string <uuid>
projectId
required
string <uuid>

Responses

Request samples

Content type
application/json
{
  • "type": "Quote.ItemsUpdated",
  • "specversion": "1.0",
  • "source": "cloud.upowr.<env>",
  • "id": "string",
  • "sequence": 0,
  • "time": "2019-08-24T14:15:22Z",
  • "data": {
    },
  • "customerId": "87d8e330-2878-4742-a86f-dbbb3bf522ac",
  • "projectId": "5a8591dd-4039-49df-9202-96385ba3eff8"
}

GovernmentSupportUpdated Webhook

The government support configuration on a quote has been updated

Request Body schema: application/json
required
type
required
string
Value: "Quote.GovernmentSupportUpdated"
specversion
required
string
Value: "1.0"

The version of the CloudEvents specification which the event uses.

source
required
string

Identifies the context in which an event happened.

id
required
string

A unique identifier for the event.

sequence
required
number

A unique (when combined with source), monotonically increasing sequence number that starts with 0. It can be used to detect duplicate events..

time
required
string <date-time>

Timestamp of when the event happened.

required
object

The event payload.

customerId
required
string <uuid>
projectId
required
string <uuid>

Responses

Request samples

Content type
application/json
{
  • "type": "Quote.GovernmentSupportUpdated",
  • "specversion": "1.0",
  • "source": "cloud.upowr.<env>",
  • "id": "string",
  • "sequence": 0,
  • "time": "2019-08-24T14:15:22Z",
  • "data": {
    },
  • "customerId": "87d8e330-2878-4742-a86f-dbbb3bf522ac",
  • "projectId": "5a8591dd-4039-49df-9202-96385ba3eff8"
}

SystemForecasted Webhook

The system forecast on a quote has been recalculated

Request Body schema: application/json
required
type
required
string
Value: "Quote.SystemForecasted"
specversion
required
string
Value: "1.0"

The version of the CloudEvents specification which the event uses.

source
required
string

Identifies the context in which an event happened.

id
required
string

A unique identifier for the event.

sequence
required
number

A unique (when combined with source), monotonically increasing sequence number that starts with 0. It can be used to detect duplicate events..

time
required
string <date-time>

Timestamp of when the event happened.

required
object

The event payload.

customerId
required
string <uuid>
projectId
required
string <uuid>

Responses

Request samples

Content type
application/json
{
  • "type": "Quote.SystemForecasted",
  • "specversion": "1.0",
  • "source": "cloud.upowr.<env>",
  • "id": "string",
  • "sequence": 0,
  • "time": "2019-08-24T14:15:22Z",
  • "data": {
    },
  • "customerId": "87d8e330-2878-4742-a86f-dbbb3bf522ac",
  • "projectId": "5a8591dd-4039-49df-9202-96385ba3eff8"
}

ExternalApprovalRequested Webhook

An external approval has been requested on a quote

Request Body schema: application/json
required
type
required
string
Value: "Quote.ExternalApprovalRequested"
specversion
required
string
Value: "1.0"

The version of the CloudEvents specification which the event uses.

source
required
string

Identifies the context in which an event happened.

id
required
string

A unique identifier for the event.

sequence
required
number

A unique (when combined with source), monotonically increasing sequence number that starts with 0. It can be used to detect duplicate events..

time
required
string <date-time>

Timestamp of when the event happened.

required
object

The event payload.

customerId
required
string <uuid>
projectId
required
string <uuid>

Responses

Request samples

Content type
application/json
{
  • "type": "Quote.ExternalApprovalRequested",
  • "specversion": "1.0",
  • "source": "cloud.upowr.<env>",
  • "id": "string",
  • "sequence": 0,
  • "time": "2019-08-24T14:15:22Z",
  • "data": {
    },
  • "customerId": "87d8e330-2878-4742-a86f-dbbb3bf522ac",
  • "projectId": "5a8591dd-4039-49df-9202-96385ba3eff8"
}

ExternalApprovalResponded Webhook

An external approval has been responded to on a quote - this may be approved or rejected

Request Body schema: application/json
required
type
required
string
Value: "Quote.ExternalApprovalResponded"
specversion
required
string
Value: "1.0"

The version of the CloudEvents specification which the event uses.

source
required
string

Identifies the context in which an event happened.

id
required
string

A unique identifier for the event.

sequence
required
number

A unique (when combined with source), monotonically increasing sequence number that starts with 0. It can be used to detect duplicate events..

time
required
string <date-time>

Timestamp of when the event happened.

required
object

The event payload.

customerId
required
string <uuid>
projectId
required
string <uuid>

Responses

Request samples

Content type
application/json
{
  • "type": "Quote.ExternalApprovalResponded",
  • "specversion": "1.0",
  • "source": "cloud.upowr.<env>",
  • "id": "string",
  • "sequence": 0,
  • "time": "2019-08-24T14:15:22Z",
  • "data": {
    },
  • "customerId": "87d8e330-2878-4742-a86f-dbbb3bf522ac",
  • "projectId": "5a8591dd-4039-49df-9202-96385ba3eff8"
}

FinanceRequested Webhook

A finance request has been initiated on a quote

Request Body schema: application/json
required
type
required
string
Value: "Quote.FinanceRequested"
specversion
required
string
Value: "1.0"

The version of the CloudEvents specification which the event uses.

source
required
string

Identifies the context in which an event happened.

id
required
string

A unique identifier for the event.

sequence
required
number

A unique (when combined with source), monotonically increasing sequence number that starts with 0. It can be used to detect duplicate events..

time
required
string <date-time>

Timestamp of when the event happened.

required
object

The event payload.

customerId
required
string <uuid>
projectId
required
string <uuid>

Responses

Request samples

Content type
application/json
{
  • "type": "Quote.FinanceRequested",
  • "specversion": "1.0",
  • "source": "cloud.upowr.<env>",
  • "id": "string",
  • "sequence": 0,
  • "time": "2019-08-24T14:15:22Z",
  • "data": {
    },
  • "customerId": "87d8e330-2878-4742-a86f-dbbb3bf522ac",
  • "projectId": "5a8591dd-4039-49df-9202-96385ba3eff8"
}

FinanceRequestApproved Webhook

A finance request on a quote has been approved

Request Body schema: application/json
required
type
required
string
Value: "Quote.FinanceRequestApproved"
specversion
required
string
Value: "1.0"

The version of the CloudEvents specification which the event uses.

source
required
string

Identifies the context in which an event happened.

id
required
string

A unique identifier for the event.

sequence
required
number

A unique (when combined with source), monotonically increasing sequence number that starts with 0. It can be used to detect duplicate events..

time
required
string <date-time>

Timestamp of when the event happened.

required
object

The event payload.

customerId
required
string <uuid>
projectId
required
string <uuid>

Responses

Request samples

Content type
application/json
{
  • "type": "Quote.FinanceRequestApproved",
  • "specversion": "1.0",
  • "source": "cloud.upowr.<env>",
  • "id": "string",
  • "sequence": 0,
  • "time": "2019-08-24T14:15:22Z",
  • "data": {
    },
  • "customerId": "87d8e330-2878-4742-a86f-dbbb3bf522ac",
  • "projectId": "5a8591dd-4039-49df-9202-96385ba3eff8"
}

FinanceRequestRejected Webhook

A finance request on a quote has been rejected

Request Body schema: application/json
required
type
required
string
Value: "Quote.FinanceRequestRejected"
specversion
required
string
Value: "1.0"

The version of the CloudEvents specification which the event uses.

source
required
string

Identifies the context in which an event happened.

id
required
string

A unique identifier for the event.

sequence
required
number

A unique (when combined with source), monotonically increasing sequence number that starts with 0. It can be used to detect duplicate events..

time
required
string <date-time>

Timestamp of when the event happened.

required
object

The event payload.

customerId
required
string <uuid>
projectId
required
string <uuid>

Responses

Request samples

Content type
application/json
{
  • "type": "Quote.FinanceRequestRejected",
  • "specversion": "1.0",
  • "source": "cloud.upowr.<env>",
  • "id": "string",
  • "sequence": 0,
  • "time": "2019-08-24T14:15:22Z",
  • "data": {
    },
  • "customerId": "87d8e330-2878-4742-a86f-dbbb3bf522ac",
  • "projectId": "5a8591dd-4039-49df-9202-96385ba3eff8"
}

FinanceRequestCancelled Webhook

A finance request on a quote has been cancelled

Request Body schema: application/json
required
type
required
string
Value: "Quote.FinanceRequestCancelled"
specversion
required
string
Value: "1.0"

The version of the CloudEvents specification which the event uses.

source
required
string

Identifies the context in which an event happened.

id
required
string

A unique identifier for the event.

sequence
required
number

A unique (when combined with source), monotonically increasing sequence number that starts with 0. It can be used to detect duplicate events..

time
required
string <date-time>

Timestamp of when the event happened.

required
object

The event payload.

customerId
required
string <uuid>
projectId
required
string <uuid>

Responses

Request samples

Content type
application/json
{
  • "type": "Quote.FinanceRequestCancelled",
  • "specversion": "1.0",
  • "source": "cloud.upowr.<env>",
  • "id": "string",
  • "sequence": 0,
  • "time": "2019-08-24T14:15:22Z",
  • "data": {
    },
  • "customerId": "87d8e330-2878-4742-a86f-dbbb3bf522ac",
  • "projectId": "5a8591dd-4039-49df-9202-96385ba3eff8"
}