External Events are OpenAPI-spec payloads emitted by kraken to AWS Eventbridge.
| Name | Type |
|---|
| required | number | string |
| required | type | string |
| required | requested_at | string |
{
"number": "string",
"type": "string",
"requested_at": "string"
}
| Name | Type |
|---|
| required | number | string |
| required | subject_number | string |
{
"number": "string",
"subject_number": "string"
}
| Event Type | Payload Version | account.communications_preferences_updated | v1 |
{
"account_number": "string",
"changes": {
"requires_postal_comms": [
"boolean"
]
}
}
| Name | Type |
|---|
| required | account_number | string |
| required | account_user_emails | array[string] |
| is_imported | boolean |
| Event Type | Payload Version | account.created | v1 |
{
"account_number": "string",
"account_user_emails": [
"string"
],
"is_imported": "boolean"
}
| Name | Type |
|---|
| required | account_number | string |
| Event Type | Payload Version | account.occupied | v1 |
{
"account_number": "string"
}
| Name | Type |
|---|
| required | account_number | string |
| required | account_user_emails | array[string] |
| required | changes | object |
| is_override | boolean |
| Event Type | Payload Version | account.updated | v1 |
{
"account_number": "string",
"account_user_emails": [
"string"
],
"changes": "object",
"is_override": "boolean"
}
| Name | Type |
|---|
| required | user_id | integer |
| required | user_email | string |
| required | linked_accounts | array |
| user_identifiers | object |
| initiator_type | string |
| is_customer_initiated | boolean |
| Event Type | Payload Version | account_user.created | v1 |
{
"user_id": "integer",
"user_email": "string",
"linked_accounts": [
"object"
],
"user_identifiers": "object",
"initiator_type": "string",
"is_customer_initiated": "boolean"
}
| Name | Type |
|---|
| required | user_id | integer |
| Event Type | Payload Version | account_user.password_changed | v1 |
| Name | Type |
|---|
| required | account_user_id | integer |
| required | account_user_number | string |
| Event Type | Payload Version | account_user.password_reset_requested | v1 |
{
"account_user_id": "integer",
"account_user_number": "string"
}
| Event Type | Payload Version | account_user.psr_records_updated | v1 |
{
"user_id": "integer",
"created_records": [
{
"description": "string",
"electricity_industry_code": "string",
"gas_industry_code": "string"
}
],
"updated_records": [
{
"description": "string",
"electricity_industry_code": "string",
"gas_industry_code": "string"
}
],
"deleted_records": [
{
"description": "string",
"electricity_industry_code": "string",
"gas_industry_code": "string"
}
]
}
| Name | Type |
|---|
| required | user_id | integer |
| required | user_email | string |
| required | linked_accounts | array |
| user_identifiers | object |
| initiator_type | string |
| is_customer_initiated | boolean |
| Event Type | Payload Version | account_user.removed | v1 |
{
"user_id": "integer",
"user_email": "string",
"linked_accounts": [
"object"
],
"user_identifiers": "object",
"initiator_type": "string",
"is_customer_initiated": "boolean"
}
| Name | Type |
|---|
| required | user_id | integer |
| required | user_email | string |
| required | linked_accounts | array |
| user_identifiers | object |
| initiator_type | string |
| is_customer_initiated | boolean |
| required | changes | object |
| is_override | boolean |
| Event Type | Payload Version | account_user.updated | v1 |
{
"user_id": "integer",
"user_email": "string",
"linked_accounts": [
"object"
],
"user_identifiers": "object",
"initiator_type": "string",
"is_customer_initiated": "boolean",
"changes": "object",
"is_override": "boolean"
}
| Name | Type |
|---|
| required | user_number | string |
| required | verification_id | integer |
| required | verification_type | string |
| Event Type | Payload Version | account_user.verification_completed | v1 |
{
"user_number": "string",
"verification_id": "integer",
"verification_type": "string"
}
| Name | Type |
|---|
| required | user_number | string |
| required | verification_id | integer |
| required | verification_type | string |
| Event Type | Payload Version | account_user.verification_started | v1 |
{
"user_number": "string",
"verification_id": "integer",
"verification_type": "string"
}
| Name | Type |
|---|
| required | description | string |
| required | electricity_industry_code | string |
| required | gas_industry_code | string |
{
"description": "string",
"electricity_industry_code": "string",
"gas_industry_code": "string"
}
| Name | Type |
|---|
| requires_postal_comms | array[boolean] |
{
"requires_postal_comms": [
"boolean"
]
}
| Name | Type |
|---|
| required | number | string |
| required | external_reference | string |
{
"number": "string",
"external_reference": "string"
}
| Name | Type |
|---|
| required | id | string |
| industry | string |
| tariff_code | string |
| tariff_payment_method | string |
{
"id": "string",
"industry": "string",
"tariff_code": "string",
"tariff_payment_method": "string"
}
| Name | Type |
|---|
| required | affiliate_account_contract_id | integer |
| required | affiliate_contract_id | integer |
| required | account_number | string |
| required | fuel | string |
| Event Type | Payload Version | affiliates.affiliate-account-contract-created | v1 |
{
"affiliate_account_contract_id": "integer",
"affiliate_contract_id": "integer",
"account_number": "string",
"fuel": "string"
}
| Name | Type |
|---|
| required | agreement_id | integer |
| required | account_number | string |
| required | valid_from | string |
| required | product_code | string |
| Event Type | Payload Version | agreement.created | v1 |
{
"agreement_id": "integer",
"account_number": "string",
"valid_from": "string",
"product_code": "string"
}
| Name | Type |
|---|
| required | agreement_id | integer |
| Event Type | Payload Version | agreement.revoked | v1 |
{
"agreement_id": "integer"
}
| Name | Type |
|---|
| required | agreement_id | integer |
| Event Type | Payload Version | agreement.terminated | v1 |
{
"agreement_id": "integer"
}
| Name | Type |
|---|
| required | agreement_id | integer |
| required | changes | object |
| is_override | boolean |
| Event Type | Payload Version | agreement.updated | v1 |
{
"agreement_id": "integer",
"changes": "object",
"is_override": "boolean"
}
| Name | Type |
|---|
| required | external_identifier | string |
| required | previous_context_id | integer |
| Event Type | Payload Version | apis.api_exception.context_updated | v1 |
{
"external_identifier": "string",
"previous_context_id": "integer"
}
| Name | Type |
|---|
| required | external_identifier | string |
| required | changes | object |
| account_number | string |
| Event Type | Payload Version | apis.api_exception.updated | v1 |
{
"external_identifier": "string",
"changes": "object",
"account_number": "string"
}
| Name | Type |
|---|
| required | number | string |
{
"account": {
"number": "string"
},
"number": "string",
"id": "string"
}
| Name | Type |
|---|
| required | id | integer |
| required | is_charge | boolean |
| required | is_credit | boolean |
| required | is_payment | boolean |
| required | is_repayment | boolean |
| required | is_reversal | boolean |
| required | is_reversed | boolean |
| source_id | integer |
| source_type | string |
{
"id": "integer",
"is_charge": "boolean",
"is_credit": "boolean",
"is_payment": "boolean",
"is_repayment": "boolean",
"is_reversal": "boolean",
"is_reversed": "boolean",
"source_id": "integer",
"source_type": "string"
}
| Name | Type |
|---|
| required | id | integer |
| required | amount | integer |
| required | is_charge | boolean |
| required | is_credit | boolean |
| required | is_payment | boolean |
| required | is_repayment | boolean |
| required | is_reversal | boolean |
| required | is_reversed | boolean |
| required | source_reason | string |
{
"id": "integer",
"amount": "integer",
"is_charge": "boolean",
"is_credit": "boolean",
"is_payment": "boolean",
"is_repayment": "boolean",
"is_reversal": "boolean",
"is_reversed": "boolean",
"source_reason": "string"
}
| Name | Type |
|---|
| required | start_at | string |
| required | end_at | string |
{
"start_at": "string",
"end_at": "string"
}
| Name | Type |
|---|
| required | account_number | string |
| required | billing_document_id | integer |
| required | billing_document_identifier | string |
| Event Type | Payload Version | billing.billing_document.issued | v1 |
{
"account_number": "string",
"billing_document_id": "integer",
"billing_document_identifier": "string"
}
| Name | Type |
|---|
| required | account_number | string |
| required | billing_document_id | integer |
| required | billing_document_identifier | string |
| Event Type | Payload Version | billing.billing_document_representation.dispatched | v1 |
{
"account_number": "string",
"billing_document_id": "integer",
"billing_document_identifier": "string"
}
| Name | Type |
|---|
| required | account_number | string |
| required | billing_document_id | integer |
| required | billing_document_identifier | string |
| required | billing_document_representation_dispatch_id | integer |
| required | billing_document_representations_id | array[integer] |
| Event Type | Payload Version | billing.billing_document_representation.dispatched | v2 |
{
"account_number": "string",
"billing_document_id": "integer",
"billing_document_identifier": "string",
"billing_document_representation_dispatch_id": "integer",
"billing_document_representations_id": [
"integer"
]
}
| Name | Type |
|---|
| required | account_number | string |
| required | billing_document_id | integer |
| required | billing_document_identifier | string |
| required | billing_document_representation_dispatch_id | integer |
| required | billing_document_representations_id | array[integer] |
| required | support_user_id | integer |
| Event Type | Payload Version | billing.billing_document_representation.dispatched | v3 |
{
"account_number": "string",
"billing_document_id": "integer",
"billing_document_identifier": "string",
"billing_document_representation_dispatch_id": "integer",
"billing_document_representations_id": [
"integer"
],
"support_user_id": "integer"
}
| Name | Type |
|---|
| required | account_number | string |
| required | previous_billing_options_id | integer |
| required | new_billing_options_id | integer |
| required | support_user_id | integer |
| Event Type | Payload Version | billing.billing_options.updated | v1 |
{
"account_number": "string",
"previous_billing_options_id": "integer",
"new_billing_options_id": "integer",
"support_user_id": "integer"
}
| Name | Type |
|---|
| required | ledger_number | string |
| required | agreement_id | integer |
| required | assigned_at | string |
| Event Type | Payload Version | billing.charging-ledger.assigned-to-agreement | v1 |
{
"ledger_number": "string",
"agreement_id": "integer",
"assigned_at": "string"
}
| Event Type | Payload Version | billing.charging.supply-point.triggered | v1 |
{
"supply_point_id": "integer",
"charge_period": {
"start_at": "string",
"end_at": "string"
}
}
| Name | Type |
|---|
| required | invoice_event_id | integer |
| Event Type | Payload Version | billing.duos_invoice.cancel | v1 |
{
"invoice_event_id": "integer"
}
| Name | Type |
|---|
| required | invoice_event_id | integer |
| Event Type | Payload Version | billing.duos_invoice.new | v1 |
{
"invoice_event_id": "integer"
}
| Name | Type |
|---|
| required | invoice_event_id | integer |
| Event Type | Payload Version | billing.duos_invoice.replace | v1 |
{
"invoice_event_id": "integer"
}
| Name | Type |
|---|
| required | account_number | string |
| required | account_user_emails | array[string] |
| required | statement_id | integer |
| Event Type | Payload Version | billing.final_bill | v1 |
{
"account_number": "string",
"account_user_emails": [
"string"
],
"statement_id": "integer"
}
| Event Type | Payload Version | billing.ledger.entry_posted | v1 |
{
"ledger": {
"account": {
"number": "string"
},
"number": "string",
"id": "string"
}
}
| Event Type | Payload Version | billing.ledger.entry_posted | v2 |
{
"ledger": {
"account": {
"number": "string"
},
"number": "string",
"id": "string"
},
"entry": {
"id": "integer",
"is_charge": "boolean",
"is_credit": "boolean",
"is_payment": "boolean",
"is_repayment": "boolean",
"is_reversal": "boolean",
"is_reversed": "boolean",
"source_id": "integer",
"source_type": "string"
}
}
| Event Type | Payload Version | billing.ledger.entry_removed | v1 |
{
"ledger": {
"account": {
"number": "string"
},
"number": "string",
"id": "string"
}
}
| Event Type | Payload Version | billing.ledger.entry_removed | v2 |
{
"ledger": {
"account": {
"number": "string"
},
"number": "string",
"id": "string"
},
"entry": {
"id": "integer",
"amount": "integer",
"is_charge": "boolean",
"is_credit": "boolean",
"is_payment": "boolean",
"is_repayment": "boolean",
"is_reversal": "boolean",
"is_reversed": "boolean",
"source_reason": "string"
}
}
| Name | Type |
|---|
| required | pathway_id | string |
| required | traversal_attempt_id | integer |
| required | traversal_attempt_context | object |
| required | trigger_id | integer |
| required | failed_action_name | string |
| required | failed_action_error | string |
| required | failed_at | string |
| Event Type | Payload Version | billing.pathway_traversal.failed | v1 |
{
"pathway_id": "string",
"traversal_attempt_id": "integer",
"traversal_attempt_context": "object",
"trigger_id": "integer",
"failed_action_name": "string",
"failed_action_error": "string",
"failed_at": "string"
}
| Name | Type |
|---|
| required | pathway_id | string |
| required | traversal_attempt_id | integer |
| required | trigger_id | integer |
| required | succeeded_at | string |
| Event Type | Payload Version | billing.pathway_traversal.succeeded | v1 |
{
"pathway_id": "string",
"traversal_attempt_id": "integer",
"trigger_id": "integer",
"succeeded_at": "string"
}
| Name | Type |
|---|
| required | account_number | string |
| required | rebate_period_id | integer |
| required | rebate_type | string |
| required | effective_from | string |
| required | effective_to | string |
| Event Type | Payload Version | billing.rebate.accepted | v1 |
{
"account_number": "string",
"rebate_period_id": "integer",
"rebate_type": "string",
"effective_from": "string",
"effective_to": "string"
}
| Name | Type |
|---|
| required | account_number | string |
| required | rebate_period_id | integer |
| required | rebate_type | string |
| required | effective_from | string |
| required | effective_to | string |
| required | is_application_accepted | boolean |
| Event Type | Payload Version | billing.rebate.created | v1 |
{
"account_number": "string",
"rebate_period_id": "integer",
"rebate_type": "string",
"effective_from": "string",
"effective_to": "string",
"is_application_accepted": "boolean"
}
| Name | Type |
|---|
| required | account_number | string |
| required | rebate_period_id | integer |
| required | rebate_type | string |
| required | effective_from | string |
| required | effective_to | string |
| required | decline_reason | string |
| Event Type | Payload Version | billing.rebate.declined | v1 |
{
"account_number": "string",
"rebate_period_id": "integer",
"rebate_type": "string",
"effective_from": "string",
"effective_to": "string",
"decline_reason": "string"
}
| Name | Type |
|---|
| required | account_number | string |
| required | rebate_period_id | integer |
| required | rebate_type | string |
| required | effective_from | string |
| required | effective_to | string |
| required | is_application_accepted | boolean |
| Event Type | Payload Version | billing.rebate.updated | v1 |
{
"account_number": "string",
"rebate_period_id": "integer",
"rebate_type": "string",
"effective_from": "string",
"effective_to": "string",
"is_application_accepted": "boolean"
}
| Name | Type |
|---|
| required | id | integer |
| Event Type | Payload Version | business.created | v1 |
| Name | Type |
|---|
| required | id | integer |
| required | changes | object |
| Event Type | Payload Version | business.updated | v1 |
{
"id": "integer",
"changes": "object"
}
| Name | Type |
|---|
| required | id | integer |
| required | operations_team_id | integer |
| Event Type | Payload Version | business_operations_team.updated | v1 |
{
"id": "integer",
"operations_team_id": "integer"
}
| Name | Type |
|---|
| required | account_number | string |
| required | campaign_name | string |
| campaign_expiry_date | string |
| campaign_account_expiry_date | string |
| Event Type | Payload Version | campaign_account.added | v1 |
{
"account_number": "string",
"campaign_name": "string",
"campaign_expiry_date": "string",
"campaign_account_expiry_date": "string"
}
| Name | Type |
|---|
| required | account_number | string |
| required | campaign_name | string |
| Event Type | Payload Version | campaign_account.removed | v1 |
{
"account_number": "string",
"campaign_name": "string"
}
| Name | Type |
|---|
| required | account_number | string |
| required | campaign_name | string |
| required | changes | object |
| Event Type | Payload Version | campaign_account.updated | v1 |
{
"account_number": "string",
"campaign_name": "string",
"changes": "object"
}
| Name | Type |
|---|
| required | number | string |
{
"account": {
"number": "string"
},
"id": "string"
}
| Name | Type |
|---|
| required | id | integer |
| required | amount | integer |
| required | payment_date | string |
| required | description | string |
| failure_reason | string |
{
"id": "integer",
"amount": "integer",
"payment_date": "string",
"description": "string",
"failure_reason": "string"
}
| Name | Type |
|---|
| required | errors | array[string] |
| required | supply_point_id | string |
| required | period_start | string |
| required | period_end | string |
| Event Type | Payload Version | charging.priming.errored | v1 |
{
"errors": [
"string"
],
"supply_point_id": "string",
"period_start": "string",
"period_end": "string"
}
| Name | Type |
|---|
| required | id | integer |
| required | account_number | string |
| amount | integer |
| campaign | string |
| required | is_white_label | boolean |
| required | agency_code | string |
| Event Type | Payload Version | collection_proceeding.created | v1 |
{
"id": "integer",
"account_number": "string",
"amount": "integer",
"campaign": "string",
"is_white_label": "boolean",
"agency_code": "string"
}
| Name | Type |
|---|
| required | number | string |
| required | account_number | string |
| ledger | string |
| billing_document | string |
| required | config_code | string |
| Event Type | Payload Version | collection_process.raised | v1 |
{
"number": "string",
"account_number": "string",
"ledger": "string",
"billing_document": "string",
"config_code": "string"
}
| Name | Type |
|---|
| required | number | string |
| Event Type | Payload Version | collection_process.reactivated | v1 |
| Name | Type |
|---|
| required | number | string |
| Event Type | Payload Version | collection_process.run_termination_requested | v1 |
| Name | Type |
|---|
| required | number | string |
| required | account_number | string |
| required | external_reference | string |
| Event Type | Payload Version | collection_process.withdrawn | v1 |
{
"number": "string",
"account_number": "string",
"external_reference": "string"
}
| Name | Type |
|---|
| required | number | string |
| required | account_number | string |
| Event Type | Payload Version | collection_process.withdrawn | v2 |
{
"number": "string",
"account_number": "string"
}
| Name | Type |
|---|
| required | account_number | string |
| required | call_id | integer |
| required | call_key | string |
| required | transcript_key | string |
| required | redacted_transcript_key | string |
| required | bucket | string |
| required | changes | object |
| Event Type | Payload Version | comms.account-call.updated | v1 |
{
"account_number": "string",
"call_id": "integer",
"call_key": "string",
"transcript_key": "string",
"redacted_transcript_key": "string",
"bucket": "string",
"changes": "object"
}
| Name | Type |
|---|
| required | push_notification_binding_id | integer |
| Event Type | Payload Version | comms.push-notification.received-unregistered-or-expired-token | v1 |
{
"push_notification_binding_id": "integer"
}
| Name | Type |
|---|
| required | account_number | string |
| required | call_id | integer |
| required | call_key | string |
| required | transcript_key | string |
| required | redacted_transcript_key | string |
| required | bucket | string |
| Event Type | Payload Version | comms.transcription.created | v1 |
{
"account_number": "string",
"call_id": "integer",
"call_key": "string",
"transcript_key": "string",
"redacted_transcript_key": "string",
"bucket": "string"
}
| Name | Type |
|---|
| required | id | integer |
| required | consent_type_code | string |
| required | value | string |
| required | signed_at | string |
{
"id": "integer",
"consent_type_code": "string",
"value": "string",
"signed_at": "string"
}
| Name | Type |
|---|
| required | identity_type | string |
| required | identity | string |
{
"identity_type": "string",
"identity": "string"
}
| Event Type | Payload Version | consents.consent.created | v1 |
{
"signing_identity": {
"identity_type": "string",
"identity": "string"
},
"consent": {
"id": "integer",
"consent_type_code": "string",
"value": "string",
"signed_at": "string"
}
}
| Event Type | Payload Version | consents.consent.updated | v1 |
{
"signing_identity": {
"identity_type": "string",
"identity": "string"
},
"consent": {
"id": "integer",
"consent_type_code": "string",
"value": "string",
"signed_at": "string"
}
}
| Name | Type |
|---|
| required | contract_identifier | string |
| required | occurred_at | string |
| sales_record_identifier | string |
| partner_commission_numbers | array[string] |
| partner_commission_overrides | object |
| Event Type | Payload Version | contracts.created | v1 |
{
"contract_identifier": "string",
"occurred_at": "string",
"sales_record_identifier": "string",
"partner_commission_numbers": [
"string"
],
"partner_commission_overrides": "object"
}
| Event Type | Payload Version | contracts.journeys.creation.started | v1 |
{
"contract_journey": {
"number": "string",
"type": "string",
"requested_at": "string"
},
"contract_identifier": "string",
"occurred_at": "string",
"subject_contract_journeys": [
{
"number": "string",
"subject_number": "string"
}
]
}
| Event Type | Payload Version | contracts.journeys.termination.started | v1 |
{
"contract_journey": {
"number": "string",
"type": "string",
"requested_at": "string"
},
"contract_identifier": "string",
"occurred_at": "string",
"subject_contract_journeys": [
{
"number": "string",
"subject_number": "string"
}
]
}
| Event Type | Payload Version | contracts.journeys.variation.started | v1 |
{
"contract_journey": {
"number": "string",
"type": "string",
"requested_at": "string"
},
"contract_identifier": "string",
"occurred_at": "string"
}
| Name | Type |
|---|
| required | contract_identifier | string |
| required | occurred_at | string |
| Event Type | Payload Version | contracts.revoked | v1 |
{
"contract_identifier": "string",
"occurred_at": "string"
}
| Name | Type |
|---|
| required | contract_identifier | string |
| required | occurred_at | string |
| Event Type | Payload Version | contracts.terminated | v1 |
{
"contract_identifier": "string",
"occurred_at": "string"
}
| Name | Type |
|---|
| required | contract_identifier | string |
| required | occurred_at | string |
| Event Type | Payload Version | contracts.terms-varied | v1 |
{
"contract_identifier": "string",
"occurred_at": "string"
}
| Name | Type |
|---|
| required | code | string |
| required | permissions | array[string] |
| Event Type | Payload Version | customer_access.partner_roles.created | v1 |
{
"code": "string",
"permissions": [
"string"
]
}
| Name | Type |
|---|
| required | code | string |
| required | permissions | array[string] |
| Event Type | Payload Version | customer_access.partner_user_roles.created | v1 |
{
"code": "string",
"permissions": [
"string"
]
}
| Name | Type |
|---|
| required | resource_type | string |
| required | external_identifier | string |
| required | expiry_window_end | string |
| Event Type | Payload Version | data_import.import_process.cancelled | v1 |
{
"resource_type": "string",
"external_identifier": "string",
"expiry_window_end": "string"
}
| Name | Type |
|---|
| required | resource_type | string |
| required | external_identifier | string |
| required | identifier | string |
| Event Type | Payload Version | data_import.import_process.complete | v1 |
{
"resource_type": "string",
"external_identifier": "string",
"identifier": "string"
}
| Name | Type |
|---|
| required | resource_type | string |
| required | external_identifier | string |
| Event Type | Payload Version | data_import.import_process.dry_run_complete | v1 |
{
"resource_type": "string",
"external_identifier": "string"
}
| Name | Type |
|---|
| required | resource_type | string |
| required | external_identifier | string |
| required | error_code | string |
| required | error_detail | string |
| Event Type | Payload Version | data_import.import_process.dry_run_error | v1 |
{
"resource_type": "string",
"external_identifier": "string",
"error_code": "string",
"error_detail": "string"
}
| Name | Type |
|---|
| required | resource_type | string |
| required | external_identifier | string |
| required | error_code | string |
| required | error_detail | string |
| Event Type | Payload Version | data_import.import_process.error | v1 |
{
"resource_type": "string",
"external_identifier": "string",
"error_code": "string",
"error_detail": "string"
}
| Name | Type |
|---|
| required | ledger_number | string |
| required | account_number | string |
| required | amount | integer |
| Event Type | Payload Version | debt.actioning.automated_debt_write_back.completed | v1 |
{
"ledger_number": "string",
"account_number": "string",
"amount": "integer"
}
| Name | Type |
|---|
| required | ledger_number | string |
| required | account_number | string |
| required | reason | string |
| required | exception | string |
| Event Type | Payload Version | debt.actioning.automated_debt_write_back.failed | v1 |
{
"ledger_number": "string",
"account_number": "string",
"reason": "string",
"exception": "string"
}
| Name | Type |
|---|
| required | ledger_number | string |
| required | account_number | string |
| required | reason | string |
| Event Type | Payload Version | debt.actioning.automated_debt_write_back.skipped | v1 |
{
"ledger_number": "string",
"account_number": "string",
"reason": "string"
}
| Name | Type |
|---|
| required | ledger_number | string |
| required | changed_on | string |
| required | previous_value | integer |
| required | new_value | integer |
| Event Type | Payload Version | delinquent_debt.position_changed | v1 |
{
"ledger_number": "string",
"changed_on": "string",
"previous_value": "integer",
"new_value": "integer"
}
| Name | Type |
|---|
| required | ledger_number | string |
| required | changed_on | string |
| required | previous_value | integer |
| required | new_value | integer |
| required | account_number | string |
| Event Type | Payload Version | delinquent_debt.position_changed | v2 |
{
"ledger_number": "string",
"changed_on": "string",
"previous_value": "integer",
"new_value": "integer",
"account_number": "string"
}
| Name | Type |
|---|
| required | deposit_key | string |
| required | reason | string |
| required | amount | integer |
| required | account_number | string |
| required | ledger_identifier | string |
| required | accepted_at | string |
| Event Type | Payload Version | deposit_agreement.accepted | v1 |
{
"deposit_key": "string",
"reason": "string",
"amount": "integer",
"account_number": "string",
"ledger_identifier": "string",
"accepted_at": "string"
}
| Name | Type |
|---|
| required | deposit_key | string |
| required | reason | string |
| required | amount | integer |
| required | account_number | string |
| required | ledger_identifier | string |
| required | fulfilled_at | string |
| Event Type | Payload Version | deposit_agreement.fulfilled | v1 |
{
"deposit_key": "string",
"reason": "string",
"amount": "integer",
"account_number": "string",
"ledger_identifier": "string",
"fulfilled_at": "string"
}
| Name | Type |
|---|
| required | deposit_key | string |
| required | reason | string |
| required | amount | integer |
| required | account_number | string |
| required | ledger_identifier | string |
| required | returned_amount | integer |
| required | returned_at | string |
| Event Type | Payload Version | deposit_agreement.instalment_returned | v1 |
{
"deposit_key": "string",
"reason": "string",
"amount": "integer",
"account_number": "string",
"ledger_identifier": "string",
"returned_amount": "integer",
"returned_at": "string"
}
| Name | Type |
|---|
| required | deposit_key | string |
| required | reason | string |
| required | amount | integer |
| required | account_number | string |
| required | ledger_identifier | string |
| required | returned_at | string |
| Event Type | Payload Version | deposit_agreement.returned | v1 |
{
"deposit_key": "string",
"reason": "string",
"amount": "integer",
"account_number": "string",
"ledger_identifier": "string",
"returned_at": "string"
}
| Name | Type |
|---|
| required | deposit_key | string |
| required | reason | string |
| required | amount | integer |
| required | account_number | string |
| required | ledger_identifier | string |
| required | withdrawn_at | string |
| Event Type | Payload Version | deposit_agreement.withdrawn | v1 |
{
"deposit_key": "string",
"reason": "string",
"amount": "integer",
"account_number": "string",
"ledger_identifier": "string",
"withdrawn_at": "string"
}
| Name | Type |
|---|
| required | account_number | string |
| required | dunning_path_name | string |
| required | dunning_process_id | string |
| required | pause_start_date | string |
| required | pause_end_date | string |
| required | created_note | string |
| Event Type | Payload Version | dunning_path_paused | v1 |
{
"account_number": "string",
"dunning_path_name": "string",
"dunning_process_id": "string",
"pause_start_date": "string",
"pause_end_date": "string",
"created_note": "string"
}
| Name | Type |
|---|
| required | dunning_path_name | string |
| required | dunning_process_id | string |
| required | account_number | string |
| required | created_note | string |
| required | start_date | string |
| Event Type | Payload Version | dunning_path_started | v1 |
{
"dunning_path_name": "string",
"dunning_process_id": "string",
"account_number": "string",
"created_note": "string",
"start_date": "string"
}
| Name | Type |
|---|
| required | account_number | string |
| required | dunning_path_name | string |
| required | dunning_process_id | string |
| Event Type | Payload Version | dunning_path_unpaused | v1 |
{
"account_number": "string",
"dunning_path_name": "string",
"dunning_process_id": "string"
}
| Name | Type |
|---|
| required | account_number | string |
| required | dunning_path_name | string |
| required | dunning_process_id | string |
| required | withdrawn_date | string |
| required | withdrawn_note | string |
| Event Type | Payload Version | dunning_path_withdrawn | v1 |
{
"account_number": "string",
"dunning_path_name": "string",
"dunning_process_id": "string",
"withdrawn_date": "string",
"withdrawn_note": "string"
}
| Name | Type |
|---|
| required | account | object |
| Event Type | Payload Version | gas.lla.sign-up | v1 |
| Name | Type |
|---|
| required | purchase_id | integer |
| required | account_id | integer |
| support_user_id | integer |
| Event Type | Payload Version | goods.purchase-created | v1 |
{
"purchase_id": "integer",
"account_id": "integer",
"support_user_id": "integer"
}
| Name | Type |
|---|
| required | account_number | string |
| required | market_name | string |
| required | quote_id | integer |
| required | client_params | object |
| required | lead_id | integer |
| Event Type | Payload Version | goods.quote.created-for-account | v1 |
{
"account_number": "string",
"market_name": "string",
"quote_id": "integer",
"client_params": "object",
"lead_id": "integer"
}
| Name | Type |
|---|
| required | market_name | string |
| required | quote_id | integer |
| required | contact_info | object |
| required | client_params | object |
| required | lead_id | integer |
| Event Type | Payload Version | goods.quote.created-without-account | v1 |
{
"market_name": "string",
"quote_id": "integer",
"contact_info": "object",
"client_params": "object",
"lead_id": "integer"
}
| Name | Type |
|---|
| required | mpan | string |
| required | energisation_status | string |
| required | effective_from | string |
| Event Type | Payload Version | industry.electricity.change_of_energisation.unsolicited_message | v1 |
{
"mpan": "string",
"energisation_status": "string",
"effective_from": "string"
}
| Name | Type |
|---|
| required | mpan | string |
| required | serial_number | string |
| required | effective_from | string |
| Event Type | Payload Version | industry.electricity.change_of_service.meter_deactivated | v1 |
{
"mpan": "string",
"serial_number": "string",
"effective_from": "string"
}
| Name | Type |
|---|
| required | meter_point_identifier | string |
| Event Type | Payload Version | industry.electricity.change_of_supply.gain.initiated | v1 |
{
"meter_point_identifier": "string"
}
| Name | Type |
|---|
| required | meter_point_identifier | string |
| Event Type | Payload Version | industry.gas.change_of_supply.gain.initiated | v1 |
{
"meter_point_identifier": "string"
}
| Name | Type |
|---|
| from_address | string |
| subject | string |
| to_addresses | array[string] |
| required | tags | array[string] |
{
"from_address": "string",
"subject": "string",
"to_addresses": [
"string"
],
"tags": [
"string"
]
}
{
"message_id": "integer",
"occurred_at": "string",
"channel": "string",
"content": {
"from_address": "string",
"subject": "string",
"to_addresses": [
"string"
],
"tags": [
"string"
]
}
}
{
"conversation_relay_id": "string",
"account_number": "string",
"message": {
"relay_id": "string",
"channel": "string",
"occurred_at": "string"
}
}
| Name | Type |
|---|
| required | type | string |
| required | reason | string |
| required | occurred_at | string |
{
"type": "string",
"reason": "string",
"occurred_at": "string"
}
| Name | Type |
|---|
| required | relay_id | string |
| required | channel | string |
| required | occurred_at | string |
{
"relay_id": "string",
"channel": "string",
"occurred_at": "string"
}
| Name | Type |
|---|
| required | relay_id | string |
| required | vendor | string |
| required | vendor_id | string |
| required | channel | string |
| required | occurred_at | string |
{
"relay_id": "string",
"vendor": "string",
"vendor_id": "string",
"channel": "string",
"occurred_at": "string"
}
| Event Type | Payload Version | ink.content.inbound-message-tagged | v1 |
{
"conversation_id": "integer",
"account_number": "string",
"message": {
"message_id": "integer",
"occurred_at": "string",
"channel": "string",
"content": {
"from_address": "string",
"subject": "string",
"to_addresses": [
"string"
],
"tags": [
"string"
]
}
}
}
| Name | Type |
|---|
| required | conversation_relay_id | string |
| required | bucket_relay_id | string |
| required | support_user_id | integer |
| required | organisation_id | integer |
| Event Type | Payload Version | ink.conversation.assigned_to_bucket | v1 |
{
"conversation_relay_id": "string",
"bucket_relay_id": "string",
"support_user_id": "integer",
"organisation_id": "integer"
}
| Name | Type |
|---|
| required | conversation_relay_id | string |
| required | timeline_relay_id | string |
| required | support_user_id | integer |
| Event Type | Payload Version | ink.conversation.assigned_to_timeline | v1 |
{
"conversation_relay_id": "string",
"timeline_relay_id": "string",
"support_user_id": "integer"
}
| Name | Type |
|---|
| required | conversation_id | integer |
| required | conversation_relay_id | string |
| required | closed_at | string |
| required | reason | string |
| required | account_number | string |
| required | latest_contacted_account_user_number | string |
| required | support_user_id | integer |
| required | organisation_id | integer |
| Event Type | Payload Version | ink.conversation.closed | v1 |
{
"conversation_id": "integer",
"conversation_relay_id": "string",
"closed_at": "string",
"reason": "string",
"account_number": "string",
"latest_contacted_account_user_number": "string",
"support_user_id": "integer",
"organisation_id": "integer"
}
| Name | Type |
|---|
| required | conversation_id | integer |
| required | conversation_relay_id | string |
| required | old_priority | number |
| required | new_priority | number |
| required | prioritized_at | string |
| required | message_id | integer |
| required | message_relay_id | string |
| required | account_number | string |
| required | latest_contacted_account_user_number | string |
| required | support_user_id | integer |
| required | organisation_id | integer |
| Event Type | Payload Version | ink.conversation.priority.changed | v1 |
{
"conversation_id": "integer",
"conversation_relay_id": "string",
"old_priority": "number",
"new_priority": "number",
"prioritized_at": "string",
"message_id": "integer",
"message_relay_id": "string",
"account_number": "string",
"latest_contacted_account_user_number": "string",
"support_user_id": "integer",
"organisation_id": "integer"
}
| Name | Type |
|---|
| required | conversation_relay_id | string |
| required | bucket_relay_id | string |
| required | support_user_id | integer |
| required | organisation_id | integer |
| Event Type | Payload Version | ink.conversation.unassigned_from_bucket | v1 |
{
"conversation_relay_id": "string",
"bucket_relay_id": "string",
"support_user_id": "integer",
"organisation_id": "integer"
}
| Name | Type |
|---|
| required | conversation_relay_id | string |
| required | timeline_relay_id | string |
| required | support_user_id | integer |
| Event Type | Payload Version | ink.conversation.unassigned_from_timeline | v1 |
{
"conversation_relay_id": "string",
"timeline_relay_id": "string",
"support_user_id": "integer"
}
| Name | Type |
|---|
| required | live_chat_conversation_relay_id | string |
| required | close_reason | string |
| Event Type | Payload Version | ink.live-chat.closed | v1 |
{
"live_chat_conversation_relay_id": "string",
"close_reason": "string"
}
| Event Type | Payload Version | ink.live-chat.initiated | v1 |
{
"live_chat_conversation": {
"conversation_relay_id": "string",
"account_number": "string",
"message": {
"relay_id": "string",
"channel": "string",
"occurred_at": "string"
}
}
}
| Event Type | Payload Version | ink.live-chat.messages.outbound-message-created | v1 |
{
"live_chat_conversation": {
"conversation_relay_id": "string",
"account_number": "string",
"message": {
"relay_id": "string",
"channel": "string",
"occurred_at": "string"
}
}
}
| Name | Type |
|---|
| required | filename | string |
| required | s3_key | string |
| required | s3_bucket | string |
| required | size_in_bytes | integer |
| Event Type | Payload Version | ink.message_attachment.safe | v1 |
{
"filename": "string",
"s3_key": "string",
"s3_bucket": "string",
"size_in_bytes": "integer"
}
| Name | Type |
|---|
| required | filename | string |
| required | s3_key | string |
| required | s3_bucket | string |
| required | size_in_bytes | integer |
| Event Type | Payload Version | ink.message_attachment.unsafe | v1 |
{
"filename": "string",
"s3_key": "string",
"s3_bucket": "string",
"size_in_bytes": "integer"
}
| Name | Type |
|---|
| required | message_id | string |
| required | s3_key | string |
| required | s3_bucket | string |
| Event Type | Payload Version | ink.messages.inbound-email-migration | v1 |
{
"message_id": "string",
"s3_key": "string",
"s3_bucket": "string"
}
| Event Type | Payload Version | ink.messages.inbound-message-created | v1 |
{
"conversation_relay_id": "string",
"account_number": "string",
"message": {
"relay_id": "string",
"channel": "string",
"occurred_at": "string"
}
}
| Name | Type |
|---|
| required | channel | string |
| required | vendor | string |
| required | vendor_id | string |
| required | message_relay_id | string |
| Event Type | Payload Version | ink.messages.inbound-message-ingested | v1 |
{
"channel": "string",
"vendor": "string",
"vendor_id": "string",
"message_relay_id": "string"
}
| Event Type | Payload Version | ink.messages.outbound-message-created | v1 |
{
"conversation_relay_id": "string",
"account_number": "string",
"message": {
"relay_id": "string",
"channel": "string",
"occurred_at": "string"
}
}
| Event Type | Payload Version | ink.messages.outbound-message-failed | v1 |
{
"conversation_relay_id": "string",
"message": {
"relay_id": "string",
"vendor": "string",
"vendor_id": "string",
"channel": "string",
"occurred_at": "string"
},
"failure": {
"type": "string",
"reason": "string",
"occurred_at": "string"
}
}
| Event Type | Payload Version | ink.messages.phishing-report-dismissed | v1 |
{
"conversation_relay_id": "string",
"account_number": "string",
"message": {
"relay_id": "string",
"channel": "string",
"occurred_at": "string"
}
}
| Event Type | Payload Version | ink.messages.reported-phishing | v1 |
{
"conversation_relay_id": "string",
"account_number": "string",
"message": {
"relay_id": "string",
"channel": "string",
"occurred_at": "string"
}
}
| Event Type | Payload Version | ink.messages.reported-spam | v1 |
{
"conversation_relay_id": "string",
"account_number": "string",
"message": {
"relay_id": "string",
"channel": "string",
"occurred_at": "string"
}
}
| Event Type | Payload Version | ink.messages.spam-report-dismissed | v1 |
{
"conversation_relay_id": "string",
"account_number": "string",
"message": {
"relay_id": "string",
"channel": "string",
"occurred_at": "string"
}
}
| Name | Type |
|---|
| required | id | string |
| required | actor | object |
| required | displayable_number | string |
| required | name | string |
| required | primary_registration_number | string |
| required | secondary_registration_number | string |
| required | primary_tax_identifier_number | string |
| required | legal_address | object |
| Event Type | Payload Version | internal_company.created | v1 |
{
"id": "string",
"actor": "object",
"displayable_number": "string",
"name": "string",
"primary_registration_number": "string",
"secondary_registration_number": "string",
"primary_tax_identifier_number": "string",
"legal_address": "object"
}
| Name | Type |
|---|
| required | account_number | string |
| Event Type | Payload Version | jpn.accounts.gas.application.withdrawn | v1 |
{
"account_number": "string"
}
| Name | Type |
|---|
| required | account_number | string |
| required | gpin | string |
| Event Type | Payload Version | jpn.electricity.export-switch-out.completed | v1 |
{
"account_number": "string",
"gpin": "string"
}
| Name | Type |
|---|
| required | account_number | string |
| required | gpin | string |
| Event Type | Payload Version | jpn.electricity.export-switch-out.requested | v1 |
{
"account_number": "string",
"gpin": "string"
}
| Name | Type |
|---|
| required | move_in_process_id | string |
| Event Type | Payload Version | jpn.electricity.move-in.application-withdrawn-by-occto | v1 |
{
"move_in_process_id": "string"
}
| Name | Type |
|---|
| required | move_in_process_id | string |
| Event Type | Payload Version | jpn.electricity.move-in.application-withdrawn | v1 |
{
"move_in_process_id": "string"
}
| Name | Type |
|---|
| required | move_in_process_id | string |
| Event Type | Payload Version | jpn.electricity.move-in.closed | v1 |
{
"move_in_process_id": "string"
}
| Name | Type |
|---|
| required | move_in_process_id | string |
| required | account_number | string |
| Event Type | Payload Version | jpn.electricity.move-in.completed | v1 |
{
"move_in_process_id": "string",
"account_number": "string"
}
| Name | Type |
|---|
| required | move_in_process_id | string |
| Event Type | Payload Version | jpn.electricity.move-in.duplicated | v1 |
{
"move_in_process_id": "string"
}
| Name | Type |
|---|
| required | move_in_process_id | string |
| Event Type | Payload Version | jpn.electricity.move-in.pending | v1 |
{
"move_in_process_id": "string"
}
| Name | Type |
|---|
| required | move_in_process_id | string |
| Event Type | Payload Version | jpn.electricity.move-in.ready-to-apply | v1 |
{
"move_in_process_id": "string"
}
| Name | Type |
|---|
| required | move_in_process_id | string |
| Event Type | Payload Version | jpn.electricity.move-in.registration-rejected | v1 |
{
"move_in_process_id": "string"
}
| Name | Type |
|---|
| required | move_in_process_id | string |
| Event Type | Payload Version | jpn.electricity.move-in.retried | v1 |
{
"move_in_process_id": "string"
}
| Name | Type |
|---|
| required | move_in_process_id | string |
| Event Type | Payload Version | jpn.electricity.move-in.updated | v1 |
{
"move_in_process_id": "string"
}
| Name | Type |
|---|
| required | move_in_process_id | string |
| Event Type | Payload Version | jpn.electricity.move-in.waiting-to-apply | v1 |
{
"move_in_process_id": "string"
}
| Name | Type |
|---|
| required | move_in_process_id | string |
| Event Type | Payload Version | jpn.electricity.move-in.waiting_for_move_out_application | v1 |
{
"move_in_process_id": "string"
}
| Name | Type |
|---|
| required | spin | string |
| required | old_meter_serial_number | string |
| required | new_meter_serial_number | string |
| required | replaced_at | string |
| required | reading_filename | string |
| Event Type | Payload Version | jpn.electricity.readings.meter-replaced | v1 |
{
"spin": "string",
"old_meter_serial_number": "string",
"new_meter_serial_number": "string",
"replaced_at": "string",
"reading_filename": "string"
}
| Name | Type |
|---|
| required | spin | string |
| required | account_number | string |
| Event Type | Payload Version | jpn.electricity.supply-details.updated | v1 |
{
"spin": "string",
"account_number": "string"
}
| Name | Type |
|---|
| required | spin | string |
| required | account_number | string |
| required | external_contract_capacity_update_id | integer |
| Event Type | Payload Version | jpn.electricity.supply-point-contract-capacity-update.completed | v1 |
{
"spin": "string",
"account_number": "string",
"external_contract_capacity_update_id": "integer"
}
| Name | Type |
|---|
| required | account_number | string |
| required | spin | string |
| Event Type | Payload Version | jpn.electricity.switch-out.completed | v1 |
{
"account_number": "string",
"spin": "string"
}
| Name | Type |
|---|
| required | account_number | string |
| required | spin | string |
| Event Type | Payload Version | jpn.electricity.switch-out.requested | v1 |
{
"account_number": "string",
"spin": "string"
}
| Name | Type |
|---|
| required | spin | string |
| required | application_number | string |
| Event Type | Payload Version | jpn.industry.electricity.cos_gain.matched | v1 |
{
"spin": "string",
"application_number": "string"
}
| Name | Type |
|---|
| required | spin | string |
| required | application_number | string |
| required | end_date | string |
| Event Type | Payload Version | jpn.industry.electricity.cos_loss.accepted | v1 |
{
"spin": "string",
"application_number": "string",
"end_date": "string"
}
| Name | Type |
|---|
| required | spin | string |
| required | application_number | string |
| required | end_date | string |
| Event Type | Payload Version | jpn.industry.electricity.cos_loss.completed | v1 |
{
"spin": "string",
"application_number": "string",
"end_date": "string"
}
| Name | Type |
|---|
| required | spin | string |
| required | application_number | string |
| required | end_date | string |
| Event Type | Payload Version | jpn.industry.electricity.cos_loss.withdrawn | v1 |
{
"spin": "string",
"application_number": "string",
"end_date": "string"
}
| Name | Type |
|---|
| required | gpin | string |
| required | application_number | string |
| required | end_date | string |
| Event Type | Payload Version | jpn.industry.electricity.export_cos_loss.accepted | v1 |
{
"gpin": "string",
"application_number": "string",
"end_date": "string"
}
| Name | Type |
|---|
| required | gpin | string |
| required | application_number | string |
| required | end_date | string |
| Event Type | Payload Version | jpn.industry.electricity.export_cos_loss.completed | v1 |
{
"gpin": "string",
"application_number": "string",
"end_date": "string"
}
| Name | Type |
|---|
| required | gpin | string |
| required | application_number | string |
| required | end_date | string |
| Event Type | Payload Version | jpn.industry.electricity.export_cos_loss.withdrawn | v1 |
{
"gpin": "string",
"application_number": "string",
"end_date": "string"
}
| Name | Type |
|---|
| required | supply_point_id | integer |
| required | period_start_at | string |
| required | period_end_at | string |
| Event Type | Payload Version | jpn.industry.electricity.reading.new | v1 |
{
"supply_point_id": "integer",
"period_start_at": "string",
"period_end_at": "string"
}
| Name | Type |
|---|
| required | spin | string |
| required | application_number | string |
| Event Type | Payload Version | jpn.industry.gas.disconnection.cancelled | v1 |
{
"spin": "string",
"application_number": "string"
}
| Name | Type |
|---|
| required | spin | string |
| required | supply_end_schedule_date | string |
| required | application_date | string |
| required | application_number | string |
| required | supply_end_reason | string |
| required | attendant_type | string |
| required | attendant_name | string |
| required | attendant_phone_number | string |
| required | attendant_phone_number_type | string |
| Event Type | Payload Version | jpn.industry.gas.disconnection.requested | v1 |
{
"spin": "string",
"supply_end_schedule_date": "string",
"application_date": "string",
"application_number": "string",
"supply_end_reason": "string",
"attendant_type": "string",
"attendant_name": "string",
"attendant_phone_number": "string",
"attendant_phone_number_type": "string"
}
| Name | Type |
|---|
| required | spin | string |
| required | supply_end_schedule_date | string |
| required | application_date | string |
| required | application_number | string |
| required | supply_end_reason | string |
| required | attendant_type | string |
| required | attendant_name | string |
| required | attendant_phone_number | string |
| required | attendant_phone_number_type | string |
| Event Type | Payload Version | jpn.industry.gas.disconnection.updated | v1 |
{
"spin": "string",
"supply_end_schedule_date": "string",
"application_date": "string",
"application_number": "string",
"supply_end_reason": "string",
"attendant_type": "string",
"attendant_name": "string",
"attendant_phone_number": "string",
"attendant_phone_number_type": "string"
}
| Name | Type |
|---|
| required | spin | string |
| required | previous_reading_date_type | string |
| required | new_reading_date_type | string |
| required | previous_reading_batch | string |
| required | new_reading_batch | string |
| required | previous_reading_method_type | string |
| required | new_reading_method_type | string |
| required | notification_date | string |
| Event Type | Payload Version | jpn.industry.gas.supply_point.reading_date.updated | v1 |
{
"spin": "string",
"previous_reading_date_type": "string",
"new_reading_date_type": "string",
"previous_reading_batch": "string",
"new_reading_batch": "string",
"previous_reading_method_type": "string",
"new_reading_method_type": "string",
"notification_date": "string"
}
| Name | Type |
|---|
| required | run_id | string |
| required | account_number | string |
| required | fees_applied_count | integer |
| required | fees_unapplied_count | integer |
| Event Type | Payload Version | late_payment_fee_application_service_completed | v1 |
{
"run_id": "string",
"account_number": "string",
"fees_applied_count": "integer",
"fees_unapplied_count": "integer"
}
| Name | Type |
|---|
| required | run_id | string |
| required | account_number | string |
| required | fee_amount | integer |
| required | fee_date | string |
| fee_type | string |
| required | charge_id | string |
| Event Type | Payload Version | late_payment_fee_application_service_fee_applied | v1 |
{
"run_id": "string",
"account_number": "string",
"fee_amount": "integer",
"fee_date": "string",
"fee_type": "string",
"charge_id": "string"
}
| Name | Type |
|---|
| required | run_id | string |
| required | account_number | string |
| Event Type | Payload Version | late_payment_fee_application_service_started | v1 |
{
"run_id": "string",
"account_number": "string"
}
| Name | Type |
|---|
| required | run_id | string |
| required | account_number | string |
| required | fees_calculated_count | integer |
| Event Type | Payload Version | late_payment_fee_calculation_service_completed | v1 |
{
"run_id": "string",
"account_number": "string",
"fees_calculated_count": "integer"
}
| Name | Type |
|---|
| required | run_id | string |
| required | account_number | string |
| Event Type | Payload Version | late_payment_fee_calculation_service_started | v1 |
{
"run_id": "string",
"account_number": "string"
}
| Name | Type |
|---|
| required | run_id | string |
| required | account_number | string |
| required | fees_applied_count | integer |
| required | fees_unapplied_count | integer |
| Event Type | Payload Version | late_payment_fee_calculator_completed | v1 |
{
"run_id": "string",
"account_number": "string",
"fees_applied_count": "integer",
"fees_unapplied_count": "integer"
}
| Name | Type |
|---|
| required | run_id | string |
| required | account_number | string |
| required | charge_id | string |
| Event Type | Payload Version | late_payment_fee_calculator_fee_applied | v1 |
{
"run_id": "string",
"account_number": "string",
"charge_id": "string"
}
| Name | Type |
|---|
| required | run_id | string |
| required | account_number | string |
| Event Type | Payload Version | late_payment_fee_calculator_started | v1 |
{
"run_id": "string",
"account_number": "string"
}
| Name | Type |
|---|
| required | fee_id | integer |
| required | waived_at | string |
| required | support_user_id | integer |
| Event Type | Payload Version | late_payment_fee_waived | v1 |
{
"fee_id": "integer",
"waived_at": "string",
"support_user_id": "integer"
}
| Name | Type |
|---|
| required | lead_number | string |
| required | funnel_code | string |
| required | stage | string |
| Event Type | Payload Version | leads.lead.stage-updated | v1 |
{
"lead_number": "string",
"funnel_code": "string",
"stage": "string"
}
| Name | Type |
|---|
| required | opportunity_number | string |
| required | attachment_id | integer |
| required | category | string |
| Event Type | Payload Version | leads.opportunity.document-attached-to-opportunity | v1 |
{
"opportunity_number": "string",
"attachment_id": "integer",
"category": "string"
}
| Name | Type |
|---|
| required | opportunity_number | string |
| required | offer_group_identifier | string |
| Event Type | Payload Version | leads.opportunity.offer-group.created | v2 |
{
"opportunity_number": "string",
"offer_group_identifier": "string"
}
| Name | Type |
|---|
| required | opportunity_number | string |
| required | funnel_code | string |
| required | stage | string |
| Event Type | Payload Version | leads.opportunity.stage-updated | v1 |
{
"opportunity_number": "string",
"funnel_code": "string",
"stage": "string"
}
| Name | Type |
|---|
| required | market_name | string |
| required | external_identifier | string |
| required | confirmed_ssd | string |
| required | was_cancelled | boolean |
{
"market_name": "string",
"external_identifier": "string",
"confirmed_ssd": "string",
"was_cancelled": "boolean"
}
| Name | Type |
|---|
| required | external_identifier | string |
| required | market_name | string |
| required | confirmed_supply_start_date | string |
{
"external_identifier": "string",
"market_name": "string",
"confirmed_supply_start_date": "string"
}
| Name | Type |
|---|
| required | external_identifier | string |
| required | market_name | string |
{
"external_identifier": "string",
"market_name": "string"
}
| Name | Type |
|---|
| required | id | integer |
| required | valid_from | string |
| required | valid_to | string |
| required | product_code | string |
{
"id": "integer",
"valid_from": "string",
"valid_to": "string",
"product_code": "string"
}
| Name | Type |
|---|
| required | external_identifier | string |
| required | market_name | string |
| required | requested_supply_start_date | string |
{
"external_identifier": "string",
"market_name": "string",
"requested_supply_start_date": "string"
}
| Name | Type |
|---|
| required | market_identifier | string |
| required | external_identifier | string |
| required | market_name | string |
{
"market_identifier": "string",
"external_identifier": "string",
"market_name": "string"
}
| Name | Type |
|---|
| required | external_identifier | string |
| required | market_name | string |
| required | confirmed_supply_end_date | string |
{
"external_identifier": "string",
"market_name": "string",
"confirmed_supply_end_date": "string"
}
| Event Type | Payload Version | lifecycle.enrollment.loyalty-points-qualification-reversed | v1 |
{
"join_supplier_process_number": "string",
"account_number": "string",
"supply_points_no_longer_coming_on_supply": [
{
"market_name": "string",
"external_identifier": "string",
"confirmed_ssd": "string",
"was_cancelled": "boolean"
}
],
"all_supply_points": [
{
"market_name": "string",
"external_identifier": "string",
"confirmed_ssd": "string",
"was_cancelled": "boolean"
}
]
}
| Event Type | Payload Version | lifecycle.enrollment.supply-status-qualifies-account-for-loyalty-point | v2 |
{
"join_supplier_process_id": "integer",
"join_supplier_process_number": "string",
"account_number": "string",
"supply_points_past_ssd": [
{
"market_name": "string",
"external_identifier": "string",
"confirmed_ssd": "string",
"was_cancelled": "boolean"
}
],
"all_supply_points": [
{
"market_name": "string",
"external_identifier": "string",
"confirmed_ssd": "string",
"was_cancelled": "boolean"
}
]
}
| Event Type | Payload Version | lifecycle.join-supplier.activation.completed | v1 |
{
"account_number": "string",
"join_supplier_process_number": "string",
"subtype": "string",
"activation_journey_type": "string",
"supply_point": {
"external_identifier": "string",
"market_name": "string",
"confirmed_supply_start_date": "string"
}
}
| Event Type | Payload Version | lifecycle.join-supplier.activation.initiated | v1 |
{
"account_number": "string",
"join_supplier_process_number": "string",
"subtype": "string",
"activation_journey_type": "string",
"supply_point": {
"external_identifier": "string",
"market_name": "string"
}
}
| Event Type | Payload Version | lifecycle.join-supplier.agreement.created | v1 |
{
"account_number": "string",
"join_supplier_process_number": "string",
"supply_point": {
"external_identifier": "string",
"market_name": "string",
"confirmed_supply_start_date": "string"
},
"agreements": [
{
"id": "integer",
"valid_from": "string",
"valid_to": "string",
"product_code": "string"
}
],
"contract_identifiers": [
"string"
]
}
| Event Type | Payload Version | lifecycle.join-supplier.cancellation-requested | v1 |
{
"account_number": "string",
"join_supplier_process_number": "string",
"subtype": "string",
"supply_points": [
{
"external_identifier": "string",
"market_name": "string",
"requested_supply_start_date": "string"
}
]
}
| Event Type | Payload Version | lifecycle.join-supplier.cancelled | v1 |
{
"account_number": "string",
"join_supplier_process_number": "string",
"subtype": "string",
"supply_points": [
{
"external_identifier": "string",
"market_name": "string",
"requested_supply_start_date": "string"
}
]
}
| Event Type | Payload Version | lifecycle.join-supplier.completed | v1 |
{
"account_number": "string",
"join_supplier_process_number": "string",
"subtype": "string",
"supply_points": [
{
"external_identifier": "string",
"market_name": "string",
"confirmed_supply_start_date": "string"
}
]
}
| Name | Type |
|---|
| required | account_number | string |
| required | join_supplier_process_number | string |
| required | subtype | string |
| required | supply_points |
array[lifecycle-join_supplier-SupplyPoint]
|
| required | requested_at | string |
| Event Type | Payload Version | lifecycle.join-supplier.requested | v1 |
{
"account_number": "string",
"join_supplier_process_number": "string",
"subtype": "string",
"supply_points": [
{
"external_identifier": "string",
"market_name": "string",
"requested_supply_start_date": "string"
}
],
"requested_at": "string"
}
| Event Type | Payload Version | lifecycle.join-supplier.reversal-requested | v1 |
{
"account_number": "string",
"join_supplier_process_number": "string",
"subtype": "string",
"supply_points": [
{
"external_identifier": "string",
"market_name": "string",
"requested_supply_start_date": "string"
}
]
}
| Event Type | Payload Version | lifecycle.join-supplier.reversed | v1 |
{
"account_number": "string",
"join_supplier_process_number": "string",
"subtype": "string",
"supply_points": [
{
"external_identifier": "string",
"market_name": "string",
"requested_supply_start_date": "string"
}
]
}
| Name | Type |
|---|
| required | join_supplier_process_id | integer |
| required | join_supplier_process_number | string |
| required | account_number | string |
| Event Type | Payload Version | lifecycle.join_supplier._ensure_payment_instructions.step_completed | v2 |
{
"join_supplier_process_id": "integer",
"join_supplier_process_number": "string",
"account_number": "string"
}
| Name | Type |
|---|
| required | join_supplier_process_id | integer |
| required | join_supplier_process_number | string |
| required | account_number | string |
| Event Type | Payload Version | lifecycle.join_supplier._ensure_payment_instructions.step_initiated | v2 |
{
"join_supplier_process_id": "integer",
"join_supplier_process_number": "string",
"account_number": "string"
}
| Name | Type |
|---|
| required | join_supplier_process_id | integer |
| required | join_supplier_process_number | string |
| Event Type | Payload Version | lifecycle.join_supplier.terms-and-conditions.accepted | v2 |
{
"join_supplier_process_id": "integer",
"join_supplier_process_number": "string"
}
| Name | Type |
|---|
| required | account_number | string |
| required | leave_supplier_process_id | integer |
| required | leave_supplier_process_number | string |
| required | supply_points |
array[lifecycle-leave_supplier-SupplyPoint]
|
| Event Type | Payload Version | lifecycle.leave-supplier.cancellation-requested | v2 |
{
"account_number": "string",
"leave_supplier_process_id": "integer",
"leave_supplier_process_number": "string",
"supply_points": [
{
"market_identifier": "string",
"external_identifier": "string",
"market_name": "string"
}
]
}
| Name | Type |
|---|
| required | account_number | string |
| required | leave_supplier_process_id | integer |
| required | leave_supplier_process_number | string |
| required | supply_points |
array[lifecycle-leave_supplier-SupplyPoint]
|
| Event Type | Payload Version | lifecycle.leave-supplier.cancelled | v2 |
{
"account_number": "string",
"leave_supplier_process_id": "integer",
"leave_supplier_process_number": "string",
"supply_points": [
{
"market_identifier": "string",
"external_identifier": "string",
"market_name": "string"
}
]
}
| Name | Type |
|---|
| required | account_number | string |
| required | leave_supplier_process_id | integer |
| required | leave_supplier_process_number | string |
| required | leave_supplier_process_subtype | string |
| required | supply_points |
array[lifecycle-leave_supplier-TerminatedSupplyPoint]
|
| Event Type | Payload Version | lifecycle.leave-supplier.completed | v3 |
{
"account_number": "string",
"leave_supplier_process_id": "integer",
"leave_supplier_process_number": "string",
"leave_supplier_process_subtype": "string",
"supply_points": [
{
"external_identifier": "string",
"market_name": "string",
"confirmed_supply_end_date": "string"
}
]
}
| Name | Type |
|---|
| required | account_number | string |
| required | leave_supplier_process_id | integer |
| required | supply_points |
array[lifecycle-leave_supplier-SupplyPoint]
|
| required | requested_supply_end_at | string |
| required | requested_supply_end_date | string |
| required | requested_at | string |
| required | is_passive | boolean |
| passive_loss_instigated_supply_point_id | integer |
| Event Type | Payload Version | lifecycle.leave-supplier.requested | v2 |
{
"account_number": "string",
"leave_supplier_process_id": "integer",
"supply_points": [
{
"market_identifier": "string",
"external_identifier": "string",
"market_name": "string"
}
],
"requested_supply_end_at": "string",
"requested_supply_end_date": "string",
"requested_at": "string",
"is_passive": "boolean",
"passive_loss_instigated_supply_point_id": "integer"
}
| Name | Type |
|---|
| required | account_number | string |
| required | leave_supplier_process_id | integer |
| required | leave_supplier_process_number | string |
| required | supply_points |
array[lifecycle-leave_supplier-SupplyPoint]
|
| required | requested_supply_end_at | string |
| required | requested_supply_end_date | string |
| required | requested_at | string |
| required | is_passive | boolean |
| passive_loss_instigated_supply_point_id | integer |
| Event Type | Payload Version | lifecycle.leave-supplier.requested | v3 |
{
"account_number": "string",
"leave_supplier_process_id": "integer",
"leave_supplier_process_number": "string",
"supply_points": [
{
"market_identifier": "string",
"external_identifier": "string",
"market_name": "string"
}
],
"requested_supply_end_at": "string",
"requested_supply_end_date": "string",
"requested_at": "string",
"is_passive": "boolean",
"passive_loss_instigated_supply_point_id": "integer"
}
| Name | Type |
|---|
| required | account_number | string |
| required | leave_supplier_process_id | integer |
| required | leave_supplier_process_number | string |
| required | supply_points |
array[lifecycle-leave_supplier-SupplyPoint]
|
| Event Type | Payload Version | lifecycle.leave-supplier.reversal-requested | v2 |
{
"account_number": "string",
"leave_supplier_process_id": "integer",
"leave_supplier_process_number": "string",
"supply_points": [
{
"market_identifier": "string",
"external_identifier": "string",
"market_name": "string"
}
]
}
| Event Type | Payload Version | lifecycle.leave-supplier.termination.confirmed | v2 |
{
"account_number": "string",
"leave_supplier_process_id": "integer",
"leave_supplier_process_number": "string",
"leave_supplier_process_subtype": "string",
"supply_point": {
"external_identifier": "string",
"market_name": "string",
"confirmed_supply_end_date": "string"
}
}
| Name | Type |
|---|
| required | account_number | string |
| required | leave_supplier_process_id | integer |
| required | supply_points |
array[lifecycle-leave_supplier-SupplyPoint]
|
| required | requested_supply_end_at | string |
| required | requested_supply_end_date | string |
| required | updated_at | string |
| required | is_passive | boolean |
| passive_loss_instigated_supply_point_id | integer |
| Event Type | Payload Version | lifecycle.leave-supplier.updated | v2 |
{
"account_number": "string",
"leave_supplier_process_id": "integer",
"supply_points": [
{
"market_identifier": "string",
"external_identifier": "string",
"market_name": "string"
}
],
"requested_supply_end_at": "string",
"requested_supply_end_date": "string",
"updated_at": "string",
"is_passive": "boolean",
"passive_loss_instigated_supply_point_id": "integer"
}
| Name | Type |
|---|
| required | account_number | string |
| required | leave_supplier_process_id | integer |
| required | leave_supplier_process_number | string |
| required | supply_points |
array[lifecycle-leave_supplier-SupplyPoint]
|
| required | requested_supply_end_at | string |
| required | requested_supply_end_date | string |
| required | updated_at | string |
| required | is_passive | boolean |
| passive_loss_instigated_supply_point_id | integer |
| Event Type | Payload Version | lifecycle.leave-supplier.updated | v3 |
{
"account_number": "string",
"leave_supplier_process_id": "integer",
"leave_supplier_process_number": "string",
"supply_points": [
{
"market_identifier": "string",
"external_identifier": "string",
"market_name": "string"
}
],
"requested_supply_end_at": "string",
"requested_supply_end_date": "string",
"updated_at": "string",
"is_passive": "boolean",
"passive_loss_instigated_supply_point_id": "integer"
}
| Name | Type |
|---|
| required | support_user_id | string |
| required | supply_start_date | string |
| required | trigger_action | string |
| Event Type | Payload Version | lifecycle.support-site.sale | 1.0.0 |
{
"support_user_id": "string",
"supply_start_date": "string",
"trigger_action": "string"
}
| Name | Type |
|---|
| required | user_id | integer |
| required | account_id | integer |
| Event Type | Payload Version | loyalty-points.user-role-removal | v1 |
{
"user_id": "integer",
"account_id": "integer"
}
| Name | Type |
|---|
| required | code | string |
| required | market_name | string |
| required | brand_code | string |
{
"code": "string",
"market_name": "string",
"brand_code": "string"
}
| Name | Type |
|---|
| required | issue_id | integer |
| required | issue_category | string |
| required | issue_subcategory | string |
| required | issue_status | string |
| required | market_supply_point_id | string |
| required | opened_at | string |
| required | period_start | string |
| required | period_end | string |
| required | reading_type | string |
| required | utility | string |
| Event Type | Payload Version | meter_data_quality.resolution_cancelled | v1 |
{
"issue_id": "integer",
"issue_category": "string",
"issue_subcategory": "string",
"issue_status": "string",
"market_supply_point_id": "string",
"opened_at": "string",
"period_start": "string",
"period_end": "string",
"reading_type": "string",
"utility": "string"
}
| Name | Type |
|---|
| required | issue_id | integer |
| required | issue_category | string |
| required | issue_subcategory | string |
| required | issue_status | string |
| required | market_supply_point_id | string |
| required | opened_at | string |
| required | period_start | string |
| required | period_end | string |
| required | reading_type | string |
| required | utility | string |
| required | source | string |
| Event Type | Payload Version | meter_data_quality.resolution_cancelled | v2 |
{
"issue_id": "integer",
"issue_category": "string",
"issue_subcategory": "string",
"issue_status": "string",
"market_supply_point_id": "string",
"opened_at": "string",
"period_start": "string",
"period_end": "string",
"reading_type": "string",
"utility": "string",
"source": "string"
}
| Name | Type |
|---|
| required | issue_id | integer |
| required | issue_category | string |
| required | issue_subcategory | string |
| required | issue_status | string |
| required | market_supply_point_id | string |
| required | opened_at | string |
| required | period_start | string |
| required | period_end | string |
| required | reading_type | string |
| required | utility | string |
| Event Type | Payload Version | meter_data_quality.resolution_requested | v1 |
{
"issue_id": "integer",
"issue_category": "string",
"issue_subcategory": "string",
"issue_status": "string",
"market_supply_point_id": "string",
"opened_at": "string",
"period_start": "string",
"period_end": "string",
"reading_type": "string",
"utility": "string"
}
| Name | Type |
|---|
| required | id | string |
| required | request_id | string |
| required | status | string |
| required | agent | string |
| required | kraken_work_category | string |
| required | external_job_type | string |
| required | previous_status | string |
| Event Type | Payload Version | on_site_jobs.appointment.booked | v1 |
{
"id": "string",
"request_id": "string",
"status": "string",
"agent": "string",
"kraken_work_category": "string",
"external_job_type": "string",
"previous_status": "string"
}
| Name | Type |
|---|
| required | id | string |
| required | request_id | string |
| required | status | string |
| required | agent | string |
| required | kraken_work_category | string |
| required | external_job_type | string |
| required | previous_status | string |
| Event Type | Payload Version | on_site_jobs.appointment.cancelled | v1 |
{
"id": "string",
"request_id": "string",
"status": "string",
"agent": "string",
"kraken_work_category": "string",
"external_job_type": "string",
"previous_status": "string"
}
| Name | Type |
|---|
| required | id | string |
| required | request_id | string |
| required | status | string |
| required | agent | string |
| required | kraken_work_category | string |
| required | external_job_type | string |
| required | previous_status | string |
| Event Type | Payload Version | on_site_jobs.appointment.completed | v1 |
{
"id": "string",
"request_id": "string",
"status": "string",
"agent": "string",
"kraken_work_category": "string",
"external_job_type": "string",
"previous_status": "string"
}
| Name | Type |
|---|
| required | id | string |
| required | status | string |
| required | reason | string |
| required | sub_reason | string |
| required | is_emergency | boolean |
| required | agent | string |
| required | previous_status | string |
| Event Type | Payload Version | on_site_jobs.request.appointment_failed | v1 |
{
"id": "string",
"status": "string",
"reason": "string",
"sub_reason": "string",
"is_emergency": "boolean",
"agent": "string",
"previous_status": "string"
}
| Name | Type |
|---|
| required | id | string |
| required | status | string |
| required | reason | string |
| required | sub_reason | string |
| required | is_emergency | boolean |
| required | agent | string |
| required | previous_status | string |
| Event Type | Payload Version | on_site_jobs.request.approval_rejected | v1 |
{
"id": "string",
"status": "string",
"reason": "string",
"sub_reason": "string",
"is_emergency": "boolean",
"agent": "string",
"previous_status": "string"
}
| Name | Type |
|---|
| required | id | string |
| required | status | string |
| required | reason | string |
| required | sub_reason | string |
| required | is_emergency | boolean |
| required | agent | string |
| required | previous_status | string |
| Event Type | Payload Version | on_site_jobs.request.completed | v1 |
{
"id": "string",
"status": "string",
"reason": "string",
"sub_reason": "string",
"is_emergency": "boolean",
"agent": "string",
"previous_status": "string"
}
| Name | Type |
|---|
| required | id | string |
| required | status | string |
| required | reason | string |
| required | sub_reason | string |
| required | is_emergency | boolean |
| required | agent | string |
| required | previous_status | string |
| Event Type | Payload Version | on_site_jobs.request.created | v1 |
{
"id": "string",
"status": "string",
"reason": "string",
"sub_reason": "string",
"is_emergency": "boolean",
"agent": "string",
"previous_status": "string"
}
| Name | Type |
|---|
| required | allocation_id | integer |
| required | target_reference | string |
| required | target_type | string |
| required | role_id | integer |
| required | start_at | string |
| required | end_at | string |
| required | partner_reference | string |
| Event Type | Payload Version | partner_access.granted | v1 |
{
"allocation_id": "integer",
"target_reference": "string",
"target_type": "string",
"role_id": "integer",
"start_at": "string",
"end_at": "string",
"partner_reference": "string"
}
| Name | Type |
|---|
| required | allocation_id | integer |
| required | target_reference | string |
| required | target_type | string |
| required | role_id | integer |
| required | start_at | string |
| required | end_at | string |
| required | partner_user_reference | string |
| Event Type | Payload Version | partner_user_access.granted | v1 |
{
"allocation_id": "integer",
"target_reference": "string",
"target_type": "string",
"role_id": "integer",
"start_at": "string",
"end_at": "string",
"partner_user_reference": "string"
}
| Name | Type |
|---|
| required | id | integer |
| required | group_reference | string |
| required | actioned_at | string |
| Event Type | Payload Version | payment-group.actioned | v1 |
{
"id": "integer",
"group_reference": "string",
"actioned_at": "string"
}
| Name | Type |
|---|
| required | id | integer |
| required | group_reference | string |
| required | potential_value | integer |
| required | closed_at | string |
| Event Type | Payload Version | payment-group.closed | v1 |
{
"id": "integer",
"group_reference": "string",
"potential_value": "integer",
"closed_at": "string"
}
| Name | Type |
|---|
| required | id | integer |
| required | group_reference | string |
| required | potential_value | integer |
| required | cleared_value | integer |
| required | failed_value | integer |
| required | completed_at | string |
| Event Type | Payload Version | payment-group.completed | v1 |
{
"id": "integer",
"group_reference": "string",
"potential_value": "integer",
"cleared_value": "integer",
"failed_value": "integer",
"completed_at": "string"
}
| Name | Type |
|---|
| required | id | integer |
| required | amount | integer |
| required | ledger | cashflow-_payments-Ledger |
| required | payment_reason | string |
| required | payment_type | string |
| Event Type | Payload Version | payment.cleared | v1 |
{
"id": "integer",
"amount": "integer",
"ledger": {
"account": {
"number": "string"
},
"id": "string"
},
"payment_reason": "string",
"payment_type": "string"
}
| Name | Type |
|---|
| required | id | integer |
| required | amount | integer |
| required | ledger | cashflow-_payments-Ledger |
| required | failure_reason | string |
| required | description | string |
| required | payment_date | string |
| Event Type | Payload Version | payment.failed | v1 |
{
"id": "integer",
"amount": "integer",
"ledger": {
"account": {
"number": "string"
},
"id": "string"
},
"failure_reason": "string",
"description": "string",
"payment_date": "string"
}
| Name | Type |
|---|
| required | id | integer |
| required | amount | integer |
| required | ledger | cashflow-_payments-Ledger |
| required | failure_reason | string |
| required | description | string |
| required | payment_date | string |
| Event Type | Payload Version | payment.failed_late | v1 |
{
"id": "integer",
"amount": "integer",
"ledger": {
"account": {
"number": "string"
},
"id": "string"
},
"failure_reason": "string",
"description": "string",
"payment_date": "string"
}
| Event Type | Payload Version | payment.pending | v1 |
{
"id": "integer",
"amount": "integer",
"ledger": {
"account": {
"number": "string"
},
"id": "string"
}
}
| Event Type | Payload Version | payment.re_presented | v1 |
{
"failed_payment": {
"id": "integer",
"amount": "integer",
"payment_date": "string",
"description": "string",
"failure_reason": "string"
},
"new_payment": {
"id": "integer",
"amount": "integer",
"payment_date": "string",
"description": "string",
"failure_reason": "string"
},
"ledger": {
"account": {
"number": "string"
},
"id": "string"
}
}
| Event Type | Payload Version | payment.scheduled | v1 |
{
"id": "integer",
"amount": "integer",
"ledger": {
"account": {
"number": "string"
},
"id": "string"
}
}
| Name | Type |
|---|
| required | account_number | string |
| required | supplementary_ledger_id | integer |
| required | supplementary_ledger_number | string |
| required | amount | integer |
| required | amount_outstanding | integer |
| required | payment_obligation_id | integer |
| required | due_date | string |
| Event Type | Payload Version | payment_obligation.overdue | v1 |
{
"account_number": "string",
"supplementary_ledger_id": "integer",
"supplementary_ledger_number": "string",
"amount": "integer",
"amount_outstanding": "integer",
"payment_obligation_id": "integer",
"due_date": "string"
}
| Name | Type |
|---|
| required | account_number | string |
| required | payment_plan_id | integer |
| required | old_status | string |
| required | new_status | string |
| Event Type | Payload Version | payment_plan.status_changed | v1 |
{
"account_number": "string",
"payment_plan_id": "integer",
"old_status": "string",
"new_status": "string"
}
| Name | Type |
|---|
| required | number | string |
| Name | Type |
|---|
| required | actor_type | string |
| required | id | string |
{
"actor_type": "string",
"id": "string"
}
{
"id": "string",
"account": {
"number": "string"
}
}
| Name | Type |
|---|
| required | id | integer |
| required | amount | integer |
| required | payment_date | string |
{
"id": "integer",
"amount": "integer",
"payment_date": "string"
}
| Name | Type |
|---|
| required | ledger_numbers | array[string] |
| required | from_datetime | string |
| Event Type | Payload Version | payments.payment-preferences.manual-payments-activated | v1 |
{
"ledger_numbers": [
"string"
],
"from_datetime": "string"
}
| Name | Type |
|---|
| required | ledger_numbers | array[string] |
| required | from_datetime | string |
| required | payment_method_id | string |
| Event Type | Payload Version | payments.payment-preferences.preferred-method-set-for-automatic-payments | v1 |
{
"ledger_numbers": [
"string"
],
"from_datetime": "string",
"payment_method_id": "string"
}
| Name | Type |
|---|
| required | account_number | string |
| required | ledger_number | string |
| required | schedule_id | integer |
| required | schedule_type | string |
| required | payment_preference | string |
| Event Type | Payload Version | payments.payment-schedule-preference-mismatch-detected | v1 |
{
"account_number": "string",
"ledger_number": "string",
"schedule_id": "integer",
"schedule_type": "string",
"payment_preference": "string"
}
| Name | Type |
|---|
| required | account_number | string |
| required | ledger_number | string |
| required | reason | string |
| Event Type | Payload Version | payments.payment_adequacy.review_wont_be_applied | v1 |
{
"account_number": "string",
"ledger_number": "string",
"reason": "string"
}
| Name | Type |
|---|
| required | instruction_id | string |
| Event Type | Payload Version | payments.payment_method.account_user_matching.failed | v1 |
{
"instruction_id": "string"
}
| Name | Type |
|---|
| required | account_number | string |
| required | ledger_identifier | string |
| required | usable_from | string |
| required | payment_instruction_id | string |
| required | usable_to | string |
| Event Type | Payload Version | payments.payment_method.new | v1 |
{
"account_number": "string",
"ledger_identifier": "string",
"usable_from": "string",
"payment_instruction_id": "string",
"usable_to": "string"
}
| Name | Type |
|---|
| required | account_number | string |
| required | ledger_identifier | string |
| required | usable_from | string |
| required | payment_instruction_id | string |
| required | usable_to | string |
| Event Type | Payload Version | payments.payment_method.removed | v1 |
{
"account_number": "string",
"ledger_identifier": "string",
"usable_from": "string",
"payment_instruction_id": "string",
"usable_to": "string"
}
| Name | Type |
|---|
| required | account_number | string |
| required | ledger_identifier | string |
| required | payment_schedule_id | string |
| required | payment_schedule_type | string |
| required | usable_from | string |
| required | usable_to | string |
| required | is_variable_payment_amount | boolean |
| Event Type | Payload Version | payments.payment_schedule.new | v1 |
{
"account_number": "string",
"ledger_identifier": "string",
"payment_schedule_id": "string",
"payment_schedule_type": "string",
"usable_from": "string",
"usable_to": "string",
"is_variable_payment_amount": "boolean"
}
| Name | Type |
|---|
| required | account_number | string |
| required | ledger_identifier | string |
| required | payment_schedule_id | string |
| required | preceding_schedule_id | string |
| required | payment_frequency | string |
| required | payment_frequency_multiplier | integer |
| required | valid_from | string |
| required | is_variable_payment_amount | boolean |
| required | is_exempt_from_payment_adequacy | boolean |
| Event Type | Payload Version | payments.payment_schedule.removed | v1 |
{
"account_number": "string",
"ledger_identifier": "string",
"payment_schedule_id": "string",
"preceding_schedule_id": "string",
"payment_frequency": "string",
"payment_frequency_multiplier": "integer",
"valid_from": "string",
"is_variable_payment_amount": "boolean",
"is_exempt_from_payment_adequacy": "boolean"
}
| Name | Type |
|---|
| required | account_number | string |
| required | ledger_identifier | string |
| required | payment_schedule_id | string |
| required | changes | object |
| Event Type | Payload Version | payments.payment_schedule.updated | v1 |
{
"account_number": "string",
"ledger_identifier": "string",
"payment_schedule_id": "string",
"changes": "object"
}
| Name | Type |
|---|
| required | account_number | string |
| required | supply_point_id | integer |
| required | previous_agreement_id | integer |
| required | new_agreement_id | integer |
| required | new_product | market_supply-products-Product |
| Event Type | Payload Version | product-switch.completed | v1 |
{
"account_number": "string",
"supply_point_id": "integer",
"previous_agreement_id": "integer",
"new_agreement_id": "integer",
"new_product": {
"code": "string",
"market_name": "string",
"brand_code": "string"
}
}
| Name | Type |
|---|
| required | product_switch_process_id | integer |
| Event Type | Payload Version | product-switch.initiated | v1 |
{
"product_switch_process_id": "integer"
}
| Event Type | Payload Version | property.move-in.cancelled | v1 |
{
"account": {
"number": "string",
"external_reference": "string"
},
"property_id": "integer"
}
| Event Type | Payload Version | property.move-in.date-updated | v1 |
{
"account": {
"number": "string",
"external_reference": "string"
},
"property_id": "integer",
"updated_move_in_date": "string"
}
| Name | Type |
|---|
| required | account | accounts-house_move-Account |
| required | property_id | integer |
| required | supply_point_ids | array[integer] |
| required | move_in_date | string |
| required | has_structured_billing_address | boolean |
| Event Type | Payload Version | property.move-in.market-supply.requested | v1 |
{
"account": {
"number": "string",
"external_reference": "string"
},
"property_id": "integer",
"supply_point_ids": [
"integer"
],
"move_in_date": "string",
"has_structured_billing_address": "boolean"
}
| Event Type | Payload Version | property.move-in.requested | v1 |
{
"account": {
"number": "string",
"external_reference": "string"
},
"property_id": "integer",
"supply_points": [
{
"id": "string",
"industry": "string",
"tariff_code": "string",
"tariff_payment_method": "string"
}
],
"move_in_date": "string"
}
| Event Type | Payload Version | property.move-in.requested | v2 |
{
"account": {
"number": "string",
"external_reference": "string"
},
"property_ids": [
"integer"
],
"supply_points": [
{
"id": "string",
"industry": "string",
"tariff_code": "string",
"tariff_payment_method": "string"
}
],
"move_in_date": "string"
}
| Event Type | Payload Version | property.move-out.cancelled | v1 |
{
"account": {
"number": "string",
"external_reference": "string"
},
"property_id": "integer",
"supply_points": [
{
"id": "string",
"industry": "string",
"tariff_code": "string",
"tariff_payment_method": "string"
}
],
"cancelled_move_out_date": "string"
}
| Event Type | Payload Version | property.move-out.date-updated | v1 |
{
"account": {
"number": "string",
"external_reference": "string"
},
"property_id": "integer",
"supply_points": [
{
"id": "string",
"industry": "string",
"tariff_code": "string",
"tariff_payment_method": "string"
}
],
"updated_move_out_date": "string"
}
| Event Type | Payload Version | property.move-out.requested | v1 |
{
"account": {
"number": "string",
"external_reference": "string"
},
"property_id": "integer",
"supply_points": [
{
"id": "string",
"industry": "string",
"tariff_code": "string",
"tariff_payment_method": "string"
}
],
"move_out_date": "string"
}
| Event Type | Payload Version | property.retrospective-move-out.completed | v1 |
{
"account": {
"number": "string",
"external_reference": "string"
},
"supply_point_id": "integer",
"move_out_date": "string"
}
| Name | Type |
|---|
| required | property_id | integer |
| required | account_number | string |
| required | changes | object |
| Event Type | Payload Version | property.updated | v1 |
{
"property_id": "integer",
"account_number": "string",
"changes": "object"
}
| Name | Type |
|---|
| required | code | string |
{
"name": "string",
"code": "string",
"permissions": [
{
"code": "string"
}
]
}
| Name | Type |
|---|
| required | id | integer |
| required | email | string |
{
"id": "integer",
"email": "string"
}
{
"id": "integer",
"email": "string",
"roles": [
{
"name": "string",
"code": "string",
"permissions": [
{
"code": "string"
}
]
}
]
}
{
"additions": [
{
"code": "string"
}
],
"deletions": [
{
"code": "string"
}
]
}
{
"additions": [
{
"name": "string",
"code": "string",
"permissions": [
{
"code": "string"
}
]
}
],
"deletions": [
{
"name": "string",
"code": "string",
"permissions": [
{
"code": "string"
}
]
}
]
}
| Event Type | Payload Version | rbac.PERMISSIONS_CHANGED_ON_ROLE | v1 |
{
"role": {
"name": "string",
"code": "string",
"permissions": [
{
"code": "string"
}
]
},
"changes": {
"additions": [
{
"code": "string"
}
],
"deletions": [
{
"code": "string"
}
]
},
"updated_at": "string",
"updated_by": "object"
}
| Event Type | Payload Version | rbac.ROLE_CHANGED_ON_SUPPORT_USER | v1 |
{
"support_user": {
"id": "integer",
"email": "string",
"roles": [
{
"name": "string",
"code": "string",
"permissions": [
{
"code": "string"
}
]
}
]
},
"changes": {
"additions": [
{
"name": "string",
"code": "string",
"permissions": [
{
"code": "string"
}
]
}
],
"deletions": [
{
"name": "string",
"code": "string",
"permissions": [
{
"code": "string"
}
]
}
]
},
"updated_at": "string",
"updated_by": "object"
}
| Name | Type |
|---|
| required | referred_account_number | string |
| required | referring_account_number | string |
| required | referral_id | integer |
| required | referral_scheme_code | string |
| Event Type | Payload Version | referrals.referral-created | v1 |
{
"referred_account_number": "string",
"referring_account_number": "string",
"referral_id": "integer",
"referral_scheme_code": "string"
}
| Name | Type |
|---|
| required | account_number | string |
| required | referral_id | integer |
| required | referral_scheme_code | string |
| required | is_referring_account | boolean |
| Event Type | Payload Version | referrals.referral-paid | v1 |
{
"account_number": "string",
"referral_id": "integer",
"referral_scheme_code": "string",
"is_referring_account": "boolean"
}
| Name | Type |
|---|
| required | referred_account_number | string |
| required | referral_id | integer |
| required | referral_scheme_code | string |
| Event Type | Payload Version | referrals.reward-created | v1 |
{
"referred_account_number": "string",
"referral_id": "integer",
"referral_scheme_code": "string"
}
| Event Type | Payload Version | refund.requested | v1 |
{
"id": "integer",
"amount": "integer",
"ledger": {
"id": "string",
"account": {
"number": "string"
}
},
"reason": "string",
"payment": {
"id": "integer",
"amount": "integer",
"payment_date": "string"
},
"requested_by": {
"actor_type": "string",
"id": "string"
}
}
| Name | Type |
|---|
| required | reminder_id | integer |
| required | account_number | string |
| required | reminder_type | string |
| required | reminder_params | object |
| Event Type | Payload Version | reminder.cancelled | v1 |
{
"reminder_id": "integer",
"account_number": "string",
"reminder_type": "string",
"reminder_params": "object"
}
| Name | Type |
|---|
| required | reminder_id | integer |
| required | account_number | string |
| required | reminder_type | string |
| required | reminder_params | object |
| Event Type | Payload Version | reminder.cancelled | v2 |
{
"reminder_id": "integer",
"account_number": "string",
"reminder_type": "string",
"reminder_params": "object"
}
| Name | Type |
|---|
| required | reminder_id | integer |
| required | account_number | string |
| required | reminder_type | string |
| required | reminder_params | object |
| Event Type | Payload Version | reminder.completed | v1 |
{
"reminder_id": "integer",
"account_number": "string",
"reminder_type": "string",
"reminder_params": "object"
}
| Name | Type |
|---|
| required | reminder_id | integer |
| required | account_number | string |
| required | reminder_type | string |
| required | reminder_params | object |
| Event Type | Payload Version | reminder.completed | v2 |
{
"reminder_id": "integer",
"account_number": "string",
"reminder_type": "string",
"reminder_params": "object"
}
| Name | Type |
|---|
| required | id | integer |
| required | group_reference | string |
| required | actioned_at | string |
| Event Type | Payload Version | repayment-group.actioned | v1 |
{
"id": "integer",
"group_reference": "string",
"actioned_at": "string"
}
| Name | Type |
|---|
| required | id | integer |
| required | group_reference | string |
| required | closed_at | string |
| Event Type | Payload Version | repayment-group.closed | v1 |
{
"id": "integer",
"group_reference": "string",
"closed_at": "string"
}
| Name | Type |
|---|
| required | id | integer |
| required | group_reference | string |
| required | completed_at | string |
| Event Type | Payload Version | repayment-group.completed | v1 |
{
"id": "integer",
"group_reference": "string",
"completed_at": "string"
}
| Event Type | Payload Version | repayment.approved | v1 |
{
"id": "integer",
"amount": "integer",
"ledger": {
"id": "string",
"account": {
"number": "string"
}
},
"approved_by": {
"actor_type": "string",
"id": "string"
},
"note": "string"
}
| Event Type | Payload Version | repayment.failed | v1 |
{
"id": "integer",
"amount": "integer",
"ledger": {
"id": "string",
"account": {
"number": "string"
}
},
"failure_reason": "string"
}
| Name | Type |
|---|
| required | id | integer |
| required | amount | integer |
| required | ledger | payments-repayments-Ledger |
| required | failure_reason | string |
| required | note | string |
| Event Type | Payload Version | repayment.failed | v2 |
{
"id": "integer",
"amount": "integer",
"ledger": {
"id": "string",
"account": {
"number": "string"
}
},
"failure_reason": "string",
"note": "string"
}
| Name | Type |
|---|
| required | id | integer |
| required | amount | integer |
| required | ledger | payments-repayments-Ledger |
| required | note | string |
| required | failure_reason | string |
| Event Type | Payload Version | repayment.failed_late | v1 |
{
"id": "integer",
"amount": "integer",
"ledger": {
"id": "string",
"account": {
"number": "string"
}
},
"note": "string",
"failure_reason": "string"
}
| Event Type | Payload Version | repayment.paid | v1 |
{
"id": "integer",
"amount": "integer",
"ledger": {
"id": "string",
"account": {
"number": "string"
}
},
"marked_by": {
"actor_type": "string",
"id": "string"
},
"note": "string"
}
| Event Type | Payload Version | repayment.requested | v1 |
{
"id": "integer",
"amount": "integer",
"ledger": {
"id": "string",
"account": {
"number": "string"
}
},
"reason": "string",
"requested_by": {
"actor_type": "string",
"id": "string"
}
}
| Event Type | Payload Version | repayment.submitted | v1 |
{
"id": "integer",
"amount": "integer",
"ledger": {
"id": "string",
"account": {
"number": "string"
}
},
"submitted_by": {
"actor_type": "string",
"id": "string"
},
"note": "string"
}
| Name | Type |
|---|
| account_number | string |
| required | risk_assessment_id | string |
| required | assessment_risk | string |
| run_event | string |
| required | risk_identified_assessors | array[string] |
| required | risk_absent_assessors | array[string] |
| required | risk_indeterminate_assessors | array[string] |
| required | risk_non_applicable_assessors | array[string] |
| Event Type | Payload Version | risk_assessment_completed | v1 |
{
"account_number": "string",
"risk_assessment_id": "string",
"assessment_risk": "string",
"run_event": "string",
"risk_identified_assessors": [
"string"
],
"risk_absent_assessors": [
"string"
],
"risk_indeterminate_assessors": [
"string"
],
"risk_non_applicable_assessors": [
"string"
]
}
| Name | Type |
|---|
| account_number | string |
| required | risk_assessment_id | string |
| run_event | string |
| Event Type | Payload Version | risk_assessment_started | v1 |
{
"account_number": "string",
"risk_assessment_id": "string",
"run_event": "string"
}
| Name | Type |
|---|
| required | account_user_id | integer |
| required | account_user_number | string |
| required | delegates_logged_out | boolean |
| Event Type | Payload Version | security.account_user.denied_access | v1 |
{
"account_user_id": "integer",
"account_user_number": "string",
"delegates_logged_out": "boolean"
}
| Name | Type |
|---|
| required | account_user_id | integer |
| required | account_user_number | string |
| required | delegates_logged_out | boolean |
| Event Type | Payload Version | security.account_user.forcibly_logged_out | v1 |
{
"account_user_id": "integer",
"account_user_number": "string",
"delegates_logged_out": "boolean"
}
| Name | Type |
|---|
| required | market | string |
| required | market_identifier | string |
| required | market_identifier_name | string |
| required | account_number | string |
| required | supply_start_at | string |
| Event Type | Payload Version | supply-point.gain.completed | v1 |
{
"market": "string",
"market_identifier": "string",
"market_identifier_name": "string",
"account_number": "string",
"supply_start_at": "string"
}
| Name | Type |
|---|
| required | market | string |
| required | market_identifier | string |
| required | market_identifier_name | string |
| required | account_number | string |
| required | supply_end_at | string |
| Event Type | Payload Version | supply-point.termination.completed | v1 |
{
"market": "string",
"market_identifier": "string",
"market_identifier_name": "string",
"account_number": "string",
"supply_end_at": "string"
}
| Name | Type |
|---|
| required | workflow_id | integer |
| required | workflow_name | string |
| required | previous_status | string |
| required | reason | string |
| required | direction | string |
| Event Type | Payload Version | tech.kraken.workflow.cancelled.v1 | v1 |
{
"workflow_id": "integer",
"workflow_name": "string",
"previous_status": "string",
"reason": "string",
"direction": "string"
}
| Name | Type |
|---|
| required | workflow_id | integer |
| required | workflow_name | string |
| required | previous_status | string |
| required | reason | string |
| required | direction | string |
| Event Type | Payload Version | tech.kraken.workflow.completed.v1 | v1 |
{
"workflow_id": "integer",
"workflow_name": "string",
"previous_status": "string",
"reason": "string",
"direction": "string"
}
| Name | Type |
|---|
| required | workflow_id | integer |
| required | workflow_name | string |
| required | previous_status | string |
| required | reason | string |
| required | direction | string |
| Event Type | Payload Version | tech.kraken.workflow.created.v1 | v1 |
{
"workflow_id": "integer",
"workflow_name": "string",
"previous_status": "string",
"reason": "string",
"direction": "string"
}
| Name | Type |
|---|
| required | workflow_id | integer |
| required | workflow_name | string |
| required | previous_status | string |
| required | reason | string |
| required | direction | string |
| Event Type | Payload Version | tech.kraken.workflow.errored.v1 | v1 |
{
"workflow_id": "integer",
"workflow_name": "string",
"previous_status": "string",
"reason": "string",
"direction": "string"
}
| Name | Type |
|---|
| required | workflow_id | integer |
| required | workflow_name | string |
| required | previous_status | string |
| required | reason | string |
| required | direction | string |
| Event Type | Payload Version | tech.kraken.workflow.failed.v1 | v1 |
{
"workflow_id": "integer",
"workflow_name": "string",
"previous_status": "string",
"reason": "string",
"direction": "string"
}
| Name | Type |
|---|
| required | workflow_id | integer |
| required | workflow_name | string |
| required | previous_status | string |
| required | reason | string |
| required | direction | string |
| Event Type | Payload Version | tech.kraken.workflow.skipped.v1 | v1 |
{
"workflow_id": "integer",
"workflow_name": "string",
"previous_status": "string",
"reason": "string",
"direction": "string"
}
| Name | Type |
|---|
| required | workflow_id | integer |
| required | workflow_name | string |
| required | previous_status | string |
| required | reason | string |
| required | direction | string |
| Event Type | Payload Version | tech.kraken.workflow.stalled.v1 | v1 |
{
"workflow_id": "integer",
"workflow_name": "string",
"previous_status": "string",
"reason": "string",
"direction": "string"
}
| Name | Type |
|---|
| required | workflow_id | integer |
| required | workflow_name | string |
| required | previous_status | string |
| required | reason | string |
| required | direction | string |
| Event Type | Payload Version | tech.kraken.workflow.started.v1 | v1 |
{
"workflow_id": "integer",
"workflow_name": "string",
"previous_status": "string",
"reason": "string",
"direction": "string"
}
| Name | Type |
|---|
| required | workflow_id | integer |
| required | workflow_name | string |
| required | step_id | integer |
| required | step_name | string |
| required | step_slug | string |
| required | previous_status | string |
| required | reason | string |
| required | direction | string |
| Event Type | Payload Version | tech.kraken.workflow.step.cancelled.v1 | v1 |
{
"workflow_id": "integer",
"workflow_name": "string",
"step_id": "integer",
"step_name": "string",
"step_slug": "string",
"previous_status": "string",
"reason": "string",
"direction": "string"
}
| Name | Type |
|---|
| required | workflow_id | integer |
| required | workflow_name | string |
| required | step_id | integer |
| required | step_name | string |
| required | step_slug | string |
| required | previous_status | string |
| required | reason | string |
| required | direction | string |
| Event Type | Payload Version | tech.kraken.workflow.step.completed.v1 | v1 |
{
"workflow_id": "integer",
"workflow_name": "string",
"step_id": "integer",
"step_name": "string",
"step_slug": "string",
"previous_status": "string",
"reason": "string",
"direction": "string"
}
| Name | Type |
|---|
| required | workflow_id | integer |
| required | workflow_name | string |
| required | step_id | integer |
| required | step_name | string |
| required | step_slug | string |
| required | previous_status | string |
| required | reason | string |
| required | direction | string |
| Event Type | Payload Version | tech.kraken.workflow.step.created.v1 | v1 |
{
"workflow_id": "integer",
"workflow_name": "string",
"step_id": "integer",
"step_name": "string",
"step_slug": "string",
"previous_status": "string",
"reason": "string",
"direction": "string"
}
| Name | Type |
|---|
| required | workflow_id | integer |
| required | workflow_name | string |
| required | step_id | integer |
| required | step_name | string |
| required | step_slug | string |
| required | previous_status | string |
| required | reason | string |
| required | direction | string |
| Event Type | Payload Version | tech.kraken.workflow.step.errored.v1 | v1 |
{
"workflow_id": "integer",
"workflow_name": "string",
"step_id": "integer",
"step_name": "string",
"step_slug": "string",
"previous_status": "string",
"reason": "string",
"direction": "string"
}
| Name | Type |
|---|
| required | workflow_id | integer |
| required | workflow_name | string |
| required | step_id | integer |
| required | step_name | string |
| required | step_slug | string |
| required | previous_status | string |
| required | reason | string |
| required | direction | string |
| Event Type | Payload Version | tech.kraken.workflow.step.failed.v1 | v1 |
{
"workflow_id": "integer",
"workflow_name": "string",
"step_id": "integer",
"step_name": "string",
"step_slug": "string",
"previous_status": "string",
"reason": "string",
"direction": "string"
}
| Name | Type |
|---|
| required | workflow_id | integer |
| required | workflow_name | string |
| required | step_id | integer |
| required | step_name | string |
| required | step_slug | string |
| required | previous_status | string |
| required | reason | string |
| required | direction | string |
| Event Type | Payload Version | tech.kraken.workflow.step.skipped.v1 | v1 |
{
"workflow_id": "integer",
"workflow_name": "string",
"step_id": "integer",
"step_name": "string",
"step_slug": "string",
"previous_status": "string",
"reason": "string",
"direction": "string"
}
| Name | Type |
|---|
| required | workflow_id | integer |
| required | workflow_name | string |
| required | step_id | integer |
| required | step_name | string |
| required | step_slug | string |
| required | previous_status | string |
| required | reason | string |
| required | direction | string |
| Event Type | Payload Version | tech.kraken.workflow.step.stalled.v1 | v1 |
{
"workflow_id": "integer",
"workflow_name": "string",
"step_id": "integer",
"step_name": "string",
"step_slug": "string",
"previous_status": "string",
"reason": "string",
"direction": "string"
}
| Name | Type |
|---|
| required | workflow_id | integer |
| required | workflow_name | string |
| required | step_id | integer |
| required | step_name | string |
| required | step_slug | string |
| required | previous_status | string |
| required | reason | string |
| required | direction | string |
| Event Type | Payload Version | tech.kraken.workflow.step.started.v1 | v1 |
{
"workflow_id": "integer",
"workflow_name": "string",
"step_id": "integer",
"step_name": "string",
"step_slug": "string",
"previous_status": "string",
"reason": "string",
"direction": "string"
}
| Name | Type |
|---|
| required | trigger_type_code | string |
| required | trigger_id | string |
| Event Type | Payload Version | transactional-messaging.message.dispatched | v1 |
{
"trigger_type_code": "string",
"trigger_id": "string"
}
| Name | Type |
|---|
| required | trigger_type_code | string |
| required | trigger_id | string |
| Event Type | Payload Version | transactional-messaging.trigger.failed-message-processed | v1 |
{
"trigger_type_code": "string",
"trigger_id": "string"
}
| Name | Type |
|---|
| required | trigger_type_code | string |
| required | trigger_id | string |
| Event Type | Payload Version | transactional-messaging.trigger.failed-message-processing-failed | v1 |
{
"trigger_type_code": "string",
"trigger_id": "string"
}
| Name | Type |
|---|
| required | trigger_type_code | string |
| required | trigger_id | string |
| Event Type | Payload Version | transactional-messaging.trigger.processed | v1 |
{
"trigger_type_code": "string",
"trigger_id": "string"
}
| Name | Type |
|---|
| required | trigger_type_code | string |
| required | trigger_id | string |
| Event Type | Payload Version | transactional-messaging.trigger.processing-failed | v1 |
{
"trigger_type_code": "string",
"trigger_id": "string"
}
| Name | Type |
|---|
| required | translation_key | string |
| required | internal_lang_codes | array[string] |
| Event Type | Payload Version | translation_management.CLIENT_MANAGED_TRANSLATION_SOURCE_DELETED | v1 |
{
"translation_key": "string",
"internal_lang_codes": [
"string"
]
}
| Name | Type |
|---|
| required | translation_key | string |
| required | internal_lang_codes | array[string] |
| Event Type | Payload Version | translation_management.CLIENT_MANAGED_TRANSLATION_SOURCE_EDITED | v1 |
{
"translation_key": "string",
"internal_lang_codes": [
"string"
]
}
| Name | Type |
|---|
| required | allocation_id | integer |
| required | user_id | integer |
| required | target_id | integer |
| required | target_type | string |
| required | role_id | integer |
| required | start_at | string |
| required | end_at | string |
| Event Type | Payload Version | user_access.granted | v1 |
{
"allocation_id": "integer",
"user_id": "integer",
"target_id": "integer",
"target_type": "string",
"role_id": "integer",
"start_at": "string",
"end_at": "string"
}
| Name | Type |
|---|
| required | allocation_id | integer |
| required | user_id | integer |
| required | target_id | integer |
| required | target_type | string |
| required | role_id | integer |
| required | start_at | string |
| required | end_at | string |
| Event Type | Payload Version | user_access.revoked | v1 |
{
"allocation_id": "integer",
"user_id": "integer",
"target_id": "integer",
"target_type": "string",
"role_id": "integer",
"start_at": "string",
"end_at": "string"
}
| Name | Type |
|---|
| required | entity_id | integer |
| required | type | string |
{
"entity_id": "integer",
"type": "string"
}
{
"id": "integer",
"created_at": "string",
"direction": "string",
"participant_workers": [
{
"support_user_id": "integer",
"joined_at": "string",
"left_at": "string"
}
],
"tags": [
{
"id": "integer"
}
]
}
| Name | Type |
|---|
| required | support_user_id | integer |
| required | joined_at | string |
| required | left_at | string |
{
"support_user_id": "integer",
"joined_at": "string",
"left_at": "string"
}
| Name | Type |
|---|
| required | id | integer |
| required | s3_bucket | string |
| required | s3_key | string |
{
"id": "integer",
"s3_bucket": "string",
"s3_key": "string"
}
| Name | Type |
|---|
| required | id | integer |
| required | s3_bucket | string |
| required | s3_key | string |
| required | duration_seconds | integer |
{
"id": "integer",
"s3_bucket": "string",
"s3_key": "string",
"duration_seconds": "integer"
}
| Name | Type |
|---|
| required | id | integer |
| Name | Type |
|---|
| required | s3_bucket | string |
| required | s3_key | string |
| required | type | string |
{
"s3_bucket": "string",
"s3_key": "string",
"type": "string"
}
| Name | Type |
|---|
| required | id | integer |
| required | account_id | integer |
| required | account_number | string |
| required | account_user_id | integer |
| required | account_user_number | string |
| required | inferred_account_user_number | string |
| required | support_user_id | integer |
| required | joined_at | string |
| required | left_at | string |
{
"id": "integer",
"account_id": "integer",
"account_number": "string",
"account_user_id": "integer",
"account_user_number": "string",
"inferred_account_user_number": "string",
"support_user_id": "integer",
"joined_at": "string",
"left_at": "string"
}
| Name | Type |
|---|
| required | id | integer |
| Name | Type |
|---|
| required | id | integer |
| Event Type | Payload Version | voice.call-participant.identity-updated | v1 |
{
"call_id": "integer",
"call_participant_id": "integer",
"updated_identities": [
{
"entity_id": "integer",
"type": "string"
}
],
"new_account_number": "string"
}
| Event Type | Payload Version | voice.call.wrapped | v1 |
{
"id": "integer",
"created_at": "string",
"direction": "string",
"tags": [
{
"id": "integer"
}
],
"notes": [
{
"id": "integer"
}
],
"participants": [
{
"id": "integer",
"account_id": "integer",
"account_number": "string",
"account_user_id": "integer",
"account_user_number": "string",
"inferred_account_user_number": "string",
"support_user_id": "integer",
"joined_at": "string",
"left_at": "string"
}
]
}
| Name | Type |
|---|
| required | campaign_item_id | integer |
| required | campaign_id | integer |
| required | status | string |
| required | account_id | integer |
| required | phone_number | string |
| Event Type | Payload Version | voice.campaign.update-item | v1 |
{
"campaign_item_id": "integer",
"campaign_id": "integer",
"status": "string",
"account_id": "integer",
"phone_number": "string"
}
| Event Type | Payload Version | voice.transcription.failed | v1 |
{
"account_number": "string",
"call": {
"id": "integer",
"created_at": "string",
"direction": "string",
"participant_workers": [
{
"support_user_id": "integer",
"joined_at": "string",
"left_at": "string"
}
],
"tags": [
{
"id": "integer"
}
]
},
"call_recording": {
"id": "integer",
"s3_bucket": "string",
"s3_key": "string",
"duration_seconds": "integer"
},
"error": "string"
}
| Event Type | Payload Version | voice.transcription.processed | v1 |
{
"call_id": "integer",
"account_number": "string",
"transcription_files": [
{
"s3_bucket": "string",
"s3_key": "string",
"type": "string"
}
],
"call_recording": {
"id": "integer",
"s3_bucket": "string",
"s3_key": "string"
}
}
| Event Type | Payload Version | voice.transcription.processed | v2 |
{
"account_number": "string",
"call": {
"id": "integer",
"created_at": "string",
"direction": "string",
"participant_workers": [
{
"support_user_id": "integer",
"joined_at": "string",
"left_at": "string"
}
],
"tags": [
{
"id": "integer"
}
]
},
"call_recording": {
"id": "integer",
"s3_bucket": "string",
"s3_key": "string",
"duration_seconds": "integer"
},
"transcription_files": [
{
"s3_bucket": "string",
"s3_key": "string",
"type": "string"
}
]
}
| Name | Type |
|---|
| required | voucher_purchase_id | integer |
| Event Type | Payload Version | voucher.purchased | v1 |
{
"voucher_purchase_id": "integer"
}
| Name | Type |
|---|
| required | voucher_purchase_id | integer |
| Event Type | Payload Version | voucher.redeemed | v1 |
{
"voucher_purchase_id": "integer"
}
| Name | Type |
|---|
| required | voucher_purchase_id | integer |
| Event Type | Payload Version | voucher.refunded | v1 |
{
"voucher_purchase_id": "integer"
}
| Name | Type |
|---|
| required | voucher_purchase_id | integer |
| required | from_account_number | string |
| required | to_account_number | string |
| required | transferred_at | string |
| required | transfer_note | string |
| Event Type | Payload Version | voucher.transferred | v1 |
{
"voucher_purchase_id": "integer",
"from_account_number": "string",
"to_account_number": "string",
"transferred_at": "string",
"transfer_note": "string"
}