Saltar al contenido principal

Atributos / Meta de cada tipo de evento

swipoo.transaction.1.event.transaction.created​

"attributes": {
    "id": "transactionId",
    "origin": "backoffice/widget",
    "environmentBadge"?: "true",
    "companyId"?: "someCompanyId"
  },

swipoo.transaction.1.event.status.changed​

"attributes": {
    "id": "transactionId",
    "newStatus": "some value",
  },

swipoo.transaction.1.event.field.edited​

"attributes": {
    "id": "transactionId",
    "field": "some value",
    "newValue": "some value",
  },

swipoo.transaction.1.event.incidence.open​

"attributes": {
    "id": "transactionId",
    "incidentType": "some value",
    "phone?": "some value",
    "transactionCode": "some transaction code"
  },

swipoo.transaction.1.event.incidence.close​

"attributes": {
    "id": "transactionId",
    "incidentType": "string",
  },

swipoo.transaction.1.event.active.marked​

"attributes": {
    "id": "transactionId",
  },

swipoo.transaction.1.event.active.unmarked​

"attributes": {
    "id": "transactionId",
  },

swipoo.transaction.1.event.document.upload​

"attributes": {
    "id": "transactionId",
    "fileName": "some file name",
    "field": "some field name OPTIONAL"
  },

swipoo.transaction.1.event.final.office​

"attributes": {
    "frameNumber": "frameNumber",
  },

swipoo.transaction.1.event.form.started​

"attributes": {
    "id": "transactionId",
  },

swipoo.transaction.1.event.form.received​

"attributes": {
    "id": "transactionId",
    "origin": "ferrari",
    "transactionCode": "transactionCode"
  },

swipoo.transaction.1.event.form.received.failed​

"attributes": {
    "id": "transactionId",
    "origin": "ferrari",
    "transactionCode": "transactionCode"
  },

swipoo.transaction.1.event.doc.generated​

"attributes": {
    "id": "transactionId",
  },

swipoo.transaction.1.query.transaction.transaction-code​

"attributes": {
    "transactionCode": "transactionCode",
  },

swipoo.comment.1.event.comment.new​

"attributes": {
    "id": "commentId",
    "isPublic": "boolean",
  },
  "meta": {
    "transactionId": "some value",
    "transactionCode": "some value",
    "author": "some author",
  }

swipoo.user.1.event.user.created​

"attributes": {
    "id": "userId",
    "field": "value",
    "field2": "value2",
  },

swipoo.user.1.event.field.edited​

"attributes": {
    "id": "userId",
    "field": "some field name",
    "newValue": "some new value",
  },

swipoo.user.1.event.document.upload​

"attributes": {
    "id": "userId",
    "fileName": "some file name",
    "field": "some field name OPTIONAL"
  },

swipoo.user.1.event.data.update​

"attributes": {
    "id": "userId",
    "field": "newValue",
    "field2": "newValue"
  },

swipoo.user.1.query.get.dni​

"attributes": {
    "dni": "user dni",
  },

swipoo.user.1.query.get.id​

"attributes": {
    "id": "user id",
  },

swipoo.vehicle.1.event.vehicle.created​

"attributes": {
    "id": "vehicleId",
    "field": "value",
    "field2": "value2",
  },

swipoo.vehicle.1.event.field.edited​

"attributes": {
    "id": "vehicleId",
    "field": "some value",
    "newValue": "some other value"
  },

swipoo.vehicle.1.event.document.upload​

"attributes": {
   "id": "vehicleId",
    "fileName": "some file name",
    "field": "some field name OPTIONAL"
  },

swipoo.vehicle.1.event.data.update​

"attributes": {
    "id": "vehicleId",
    "field": "newValue",
    "field2": "newValue"
  },

swipoo.vehicle.1.query.get.frame​

"attributes": {
    "frameNumber": "frameNumber",
  },

swipoo.vehicle.1.query.get.id​

"attributes": {
    "id": "vehicle id",
  },

swipoo.shipment.1.event.shipment.generated​

"attributes": {
    "id": "shipmentId",
    "receiverEmail": "someEmail",
    "receiverName": "someName",
    "otn": "someOtn",
  },
   "meta": {
    "transactionIds": ["id1", "id2"],
    "environmentalBadgeIds": ["id3", "id4"],
  }

swipoo.shipment.1.event.shipment.sent​

"attributes": {
    "id": "shipmentId",
    "receiverEmail": "someEmail",
    "receiverName": "someName",
    "otn": "someOtn",
    "companyId": "companyId" | null
  },
   "meta": {
    "transactionIds": ["id1", "id2"],
    "environmentalBadgeIds": ["id3", "id4"],
  }

swipoo.shipment.1.event.shipment.delivered​

"attributes": {
    "id": "shipmentId",
    "receiverEmail": "someEmail",
    "receiverName": "someName",
  },
  "meta": {
    "transactionIds": ["id"],
    "environmentalBadgeIds": ["id"],
  },

swipoo.shipment.1.event.tracking.updated​

"attributes": {
    "id": "shipmentId",
  },
  "meta": {
    "status": "some status",
    "trackingUrl": "some trackingUrl",
    "destination": "some destination",
    "estimatedDeliveryDate?": "some date"
  },

swipoo.shipment.1.event.shipment.incident​

"attributes": {
    "id": "shipmentId",
  },
  "meta": {
    "status": "incident",
    "reason": "some reason",
  },

swipoo.contract.1.event.contract.created​

"attributes": {
    "id": "contractId",
  },
  "meta": {
    "transactionId": "some value",
  },

swipoo.contract.1.event.signer.signed​

"attributes": {
    "id": "contractId",
    "userType": "buyer/seller/intermediary",
  },
  "meta": {
    "transactionId": "some value",
  },

swipoo.contract.1.event.contract.finished​

"attributes": {
    "id": "contractId",
  },
  "meta": {
    "transactionId": "some value",
  },

swipoo.contract.1.event.contract.deleted​

"attributes": {
    "id": "contractId",
  },
  "meta": {
    "transactionId": "some value",
  },

swipoo.company.1.query.get.id​

"attributes": {
    "id": "id",
  },

swipoo.company.1.query.get.id.aggregate​

"attributes": {
    "id": "id",
  },

swipoo.agency.1.query.get.id​

"attributes": {
    "id": "id",
  },

swipoo.traffic-report.1.event.report.sent​

"attributes": {
  "id": "reportId",
  "phone": "some phone number",
  "email": "some email",
  "plate": "some plate",
},
"meta": {
  "transactionId": "some value",
},

swipoo.enrollment.1.event.enrollment.created​

"attributes": {
    "id": "enrollmentId",
    "origin": "backoffice/widget",
  },

swipoo.enrollment.1.event.status.changed​

"attributes": {
    "id": "enrollmentId",
    "newStatus": "some value",
  },

swipoo.enrollment.1.event.field.edited​

"attributes": {
    "id": "enrollmentId",
    "field": "some value",
    "newValue": "some value",
  },

swipoo.enrollment.1.event.incidence.open​

"attributes": {
    "id": "enrollmentId",
    "incidencType": "some value",
    "phone": "some value",
  },

swipoo.enrollment.1.event.incidence.close​

"attributes": {
    "id": "enrollmentId",
  },

swipoo.enrollment.1.event.active.marked​

"attributes": {
    "id": "enrollmentId",
  },

swipoo.enrollment.1.event.active.unmarked​

"attributes": {
    "id": "enrollmentId",
  },

swipoo.enrollment.1.event.document.upload​

"attributes": {
    "id": "enrollmentId",
    "fileName": "some file name",
    "field": "some field name OPTIONAL"
  },

swipoo.enrollment.1.event.form.received​

"attributes": {
    "id": "enrollmentId",
    "origin": "ferrari",
  },

swipoo.transaction.1.event.responsible.assigned​

"attributes": {
    "id": "tramitId",
    "email": "someEmail",
  },

swipoo.transaction.1.event.responsible.unassigned​

"attributes": {
    "id": "tramitId",
    "email": "someEmail",
  },

swipoo.transaction.1.event.extra.file.added​

"attributes": {
    "id": "tramitId",
    "fileName": "some file name without the hash",
  },

swipoo.transaction.1.event.extra.file.removed​

"attributes": {
    "id": "tramitId",
    "fileName": "some file name without the hash",
  },

swipoo.transaction.1.event.label.added​

"attributes": {
    "id": "tramitId",
    "transactionCode": "tramit transaction code",
    "labelValue": "label value",
  },
"meta": {
  "name": "someName",
}

swipoo.transaction.1.event.label.removed​

"attributes": {
    "id": "tramitId",
    "labelValue": "label value",
  },
"meta": {
  "name": "someName",
}

swipoo.enrollment.1.event.responsible.assigned​

"attributes": {
    "id": "tramitId",
    "email": "someEmail",
  },

swipoo.enrollment.1.event.responsible.unassigned​

"attributes": {
    "id": "tramitId",
    "email": "someEmail",
  },

swipoo.coupon.1.command.increment.uses​

"attributes": {
    "id": "couponId",
  },

swipoo.coupon.1.query.get.coupon​

"attributes": {
    "id": "couponId",
  },

swipoo.environmental-badge.1.query.get.transaction.id​

"attributes": {
    "id": "transactionId",
  },

swipoo.environmental-badge.1.event.environmental-badge.created​

"attributes": {
   "transactionId": "transactionId || null",
      "plate": "somePlate",
      "dni": "dni",
      "badgeType": "badgeType",
      "name": "someName",
      "email": "someEmail",
  },

swipoo.transaction.1.event.agent.assigned​

"attributes": {
    "id": "transactionId",
    "name": "someName",
    "surname": "someSurname"
  },

swipoo.transaction.1.event.agent.unassigned​

"attributes": {
    "id": "transactionId",
    "name": "someName",
    "surname": "someSurname"
  },

swipoo.transaction.1.event.transaction.archived​

"attributes": {
    "id": "transactionId",
  },

swipoo.transaction.1.event.transaction.unarchived​

"attributes": {
    "id": "transactionId",
  },

swipoo.company.1.event.pro-company.created​

"attributes": {
    "id": "companyId",
  },
"meta": {
  "name": "company name",
  "email": "representative email"
}

swipoo.account.1.event.account.created​

"attributes": {
    "id": "accountId",
  },
"meta": {
  "name": "company name",
  "email": "representative email"
}

swipoo.notification.transaction.1.event.provisional.requested​

"attributes": {
    "id": "transactionId",
  },
"meta": {
  "transactionCode": "transactionCode",
  "companyName": "companyName",
}

swipoo.notification.shipment.1.event.confirm.address​

"attributes": {
    "id": "shipmentId",
  },
"meta": {
  "channel": "email",
  "channelDestination": "example@gmail.com",
  "transactionCode": "transactionCode",
  "plate": "string",
  "address": "string" | null
}

swipoo.notification.transaction.1.event.payment.successful​

"attributes": {
    "id": "string", /* Aggregate id */
    "relatedIds": "string[]", /* Ids related to the aggregated, used to filter by client scope */
    "responsibleEmail": "string", /* Email of responsible of the aggregated, used to filter by responsible */
},
"meta": {
    "name": "string",
    "phone": "string",
    "email": "string",
    "ccaa": "string",
    "brand": "string",
    "model": "string",
    "fuel": "string",
    "enrollmentDate": "string",
    "cc": "string",
    "trafficReport": "boolean",
    "environmentBadge": "boolean",
    "itpPrice": "number",
    "coupon": "string",
    "paymentMethod": "string",
    "totalAmount": "number",
    "transactionCode": "string",
    "stripePaymentId": "string",
    "isMoto": "boolean",
}

swipoo.notification.transaction.1.event.b2b-payment.successful​

"attributes": {
    "id": "string", /* Aggregate id */
    "relatedIds": "string[]", /* Ids related to the aggregated, used to filter by client scope */
    "responsibleEmail": "string", /* Email of responsible of the aggregated, used to filter by responsible */
},
"meta":{
  "companyName": "string",
  "transactionCode": "string"
}

swipoo.notification.environmental-badge.1.event.payment.successful​

"attributes": {
    "id": "string", /* Aggregate id */
    "relatedIds": "string[]", /* Ids related to the aggregated, used to filter by client scope */
    "responsibleEmail": "string", /* Email of responsible of the aggregated, used to filter by responsible */
},
"meta":{
  "user": "string",
  "amount": "number"
}

swipoo.notification.traffic-report.1.event.payment.successful​

"attributes": {
    "id": "string", /* Aggregate id */
    "relatedIds": "string[]", /* Ids related to the aggregated, used to filter by client scope */
    "responsibleEmail": "string", /* Email of responsible of the aggregated, used to filter by responsible */
},
"meta":{
  "user": "string",
  "amount": "number"
}

swipoo.notification.transfer.1.event.holded-invoice-payment.successful​

"attributes": {
    "id": "string", /* Aggregate id */
    "relatedIds": "string[]", /* Ids related to the aggregated, used to filter by client scope */
    "responsibleEmail": "string", /* Email of responsible of the aggregated, used to filter by responsible */
},
"meta":{
  "email": "string",
  "amount": "number",
  "holdedInvoiceId": "string"
}

swipoo.notification.transaction.1.event.payment.failed​

"attributes": {
    "id": "string", /* Aggregate id */
    "relatedIds": "string[]", /* Ids related to the aggregated, used to filter by client scope */
    "responsibleEmail": "string", /* Email of responsible of the aggregated, used to filter by responsible */
},
"meta": {
    "name": "string",
    "phone": "string",
    "email": "string",
    "ccaa": "string",
    "brand": "string",
    "model": "string",
    "fuel": "string",
    "enrollmentDate": "string",
    "cc": "string",
    "trafficReport": "boolean",
    "environmentBadge": "boolean",
    "itpPrice": "number",
    "coupon": "string",
    "paymentMethod": "string",
    "totalAmount": "number",
    "stripePaymentId": "string",
    "paymentErrorMessage": "string",
    "paymentErrorDocUrl": "string",
    "paymentErrorCode": "string"
}

swipoo.notification.payment.1.event.payment-link.successful​

"attributes": {
    "id": "string", /* Aggregate id */
    "relatedIds": "string[]", /* Ids related to the aggregated, used to filter by client scope */
    "responsibleEmail": "string", /* Email of responsible of the aggregated, used to filter by responsible */
},
"meta": {
    "amount": "number",
    "email": "string",
}

swipoo.notification.sell-notification.1.event.payment.successful​

"attributes": {
    "id": "string", /* Aggregate id */
    "relatedIds": "string[]", /* Ids related to the aggregated, used to filter by client scope */
    "responsibleEmail": "string", /* Email of responsible of the aggregated, used to filter by responsible */
},
"meta":{
    "user": "string",
    "amount": "number"
}

swipoo.notification.payment.1.event.automatic.successful​

"attributes": {
    "id": "string", /* Aggregate id */
    "relatedIds": "string[]", /* Ids related to the aggregated, used to filter by client scope */
    "responsibleEmail": "string", /* Email of responsible of the aggregated, used to filter by responsible */
},
"meta":{
    "companyName": "string",
    "amount": "number"
}

swipoo.notification.payment.1.event.manual.successful​

"attributes": {
  "id": "companyId",
},
"meta": {
  "amount": "number",
  "description": "payment description",
  "companyName": "some company name",
},

swipoo.notification.transfer.1.event.after-sale​

"attributes": {
    "id": "string", /* Transaction id */
},
"meta":{
    "brand": "string",
    "environmentBadge": "boolean",
    "model": "string",
    "totalPrice": "string",
    "trafficReport": "boolean",
    "transactionCode": "string",
    "uploadDocsUrl": "string",
    "cc": "string",
    "enrollmentDate": "string",
    "fuel": "string",
    "itpPrice": "number",
    "channel": "string",
    "channelDestination": "string",
    "isMoto": "boolean",
}

swipoo.notification.transaction.1.event.provisional.sent​

"attributes": {
    "id": "string", /* Transaction id */
},
"meta":{
    "transactionCode": "string",
    "fileUrl": "string",
    "channel": "string",
    "channelDestination": "string",
    "isPro": "boolean",
}

swipoo.notification.traffic-report.1.event.report.sent​

"attributes": {
    "id": "string", /* Traffic-report id */
},
"meta":{
    "plate": "string",
    "fileUrl": "string",
    "channel": "string",
    "channelDestination": "string"
}

swipoo.notification.incident.1.event.opened​

"attributes": {
    "id": "string", /* Transaction id */
},
"meta":{
  "channel": "string",
  "channelDestination": "string",
  "transactionCode": "string",
  "incidentName": "string",
  "incidentProblem": "string",
  "incidentComment": "string",
  "plate": "string",
  "isPro": "boolean",
  "brand": "string",
  "model": "string",
  "isAncove": "boolean",
}

swipoo.notification.incident.1.event.closed​

"attributes": {
    "id": "string", /* Transaction id */
},
"meta":{
  "channel": "string",
  "channelDestination": "string",
  "transactionCode": "string",
  "incidentName": "string",
  "plate": "string",
  "brand": "string",
  "model": "string",
  "isAncove": "boolean",

}

swipoo.notification.transaction.1.event.presentation-proof-dgt.upload​

"attributes": {
    "id": "string", /* Transaction id */
},
"meta":{
    "transactionCode": "string",
    "fileUrl": "string",
    "channel": "string",
    "channelDestination": "string",
    "isPro": "boolean",
    "isAncove" : "boolean",
    "plate": "string",
}

swipoo.notification.comment.1.event.new.comment​

"attributes": {
    "id": "commentId",
  },
  "meta": {
    "comment": "some comment",
    "transactionId": "some value",
    "transactionCode": "some value",
    "author": "some author",
    "isAncove": true,
    "channel": "email",
    "channelDestination": "representativeEmail",
  }

swipoo.comment.1.event.comment.deleted​

"attributes": {
    "id": "commentId",
  },
  "meta": {
    "author": "some author email",
    "transactionId": "some transaction uuid"
  }