search

reapit / foundations

Foundations platform mono repo
57 stars 21 forks source link

Request new semi-structured data for TWN to Goodlord #11203

Closed olliebennett closed 2 months ago

olliebennett commented 3 months ago

Request

Please grant us access to Semi-structured 'extras' field data as below. I also have two related questions below this request.

I have read the documentation for "Including semi-structured data in webhook events".

  1. When following that step (after you've granted us access to the data), could you confirm the value I must enter into the Semi-structured fields input - is it Opt Out OVO Energy or some slugified version?
  2. If this field only exists for one of our integrated customers, should we set up two separate webhooks (pointing at the same URL) in which we configure this semi-structured field for one only, and move TWN to that separate copy of the webhook? Or is that unnecessary (and the value will simply be blank for our customers who don't use that semi-structured field)
Philb40 commented 3 months ago

@AshDeeming Hello ash can you help us with this one we are looking to utilise asap

AshDeeming commented 3 months ago

Hi @olliebennett / @Philb40

Access for the fields mentioned above has been set up and should become active within the next 15 minutes. ClientId: TWN

Field = pOVOEnergy

As per any other semi structured data you access it using the extrasField query string parameter eg; GET /properties?extrasField=pOVOEnergy

olliebennett commented 3 months ago

Thanks @AshDeeming - and per my extra questions at the bottom of the issue, if we'd like it in the webhook, do we need a separate copy of the webhook just for TWN, or can we configure our existing webhook (which is used for other customers as well) with that extra field?

Philb40 commented 3 months ago

@AshDeeming HI ask just wanted to say really appreciate the swift response on this one thanks for jumping on I think when ollie has his other q answered we are in a good place

AshDeeming commented 3 months ago

Hi @olliebennett A separate webhook will be required for each customer where the the field differs @Philb40 no problem at all :)

olliebennett commented 3 months ago

Hi @AshDeeming, sorry to re-open this.

We've been waiting for any webhooks to come through containing the new pOVOEnergy field, but none so far have had it.

I think it has been configured correctly, from what I can see (and your system rejects incorrect values here, suggesting pOVOEnergy is correct). Screenshot shared below.

Q: Is there an issue with the configuration or something on your side preventing the flag being sent? Q: Should we expect to see the field on every webhook, or will it only show if it was checked?

The following is an example of a webhook received for which the "Opt Out OVO Energy" checkbox IS ticked (just in case it only appears when checked). The payload unfortunately does NOT contain anything related to the checkbox;

{
  "new": {
    "agentRole": "rentCollection",
    "rentInstalmentsFrequency": "monthly",
    "arrears": {
      "paymentPlan": "no",
      "chaseArrears": true
    },
    "endDate": "2024-08-24",
    "endDateConfirmed": true,
    "source": {
      "id": "SRC002",
      "type": "source"
    },
    "rent": REDACTED,
    "related": [
      {
        "title": "REDACTED",
        "type": "contact",
        "occupyOn": "2023-02-25",
        "forename": "REDACTED",
        "mobilePhone": "REDACTED",
        "surname": "REDACTED",
        "name": "REDACTED",
        "marketingConsent": "grant",
        "fromArchive": false,
        "id": "SML23000308",
        "primaryAddress": {
          "buildingName": "REDACTED",
          "line4": "",
          "postcode": "REDACTED",
          "buildingNumber": "REDACTED",
          "line3": "",
          "line2": "REDACTED",
          "line1": "REDACTED",
          "countryId": "GB"
        },
        "vacateOn": "2024-08-24",
        "email": "REDACTED"
      },
      {
        "paymentReference": "REDACTED",
        "title": "REDACTED",
        "type": "contact",
        "occupyOn": "2023-02-25",
        "forename": "REDACTED",
        "mobilePhone": "REDACTED",
        "surname": "REDACTED",
        "name": "REDACTED",
        "marketingConsent": "grant",
        "fromArchive": false,
        "id": "SML23000309",
        "primaryAddress": {
          "buildingName": "REDACTED",
          "line4": "",
          "postcode": "REDACTED",
          "buildingNumber": "REDACTED",
          "line3": "",
          "line2": "REDACTED",
          "line1": "REDACTED",
          "countryId": "GB"
        },
        "vacateOn": "2024-08-24",
        "email": "REDACTED"
      }
    ],
    "modified": "2024-06-25T11:43:50Z",
    "id": "SML230021",
    "applicantId": "",
    "propertyId": "STM230001",
    "rentInstalmentsAmount": 1300,
    "rentFrequency": "monthly",
    "created": "2023-02-10T09:21:46Z",
    "isPeriodic": false,
    "managementFee": {
      "amount": REDACTED,
      "type": "percentage",
      "frequency": "monthly"
    },
    "deposit": {
      "period": 5,
      "heldBy": "landlord",
      "sum": REDACTED,
      "type": "weeksRent"
    },
    "fromArchive": false,
    "typeId": "RC",
    "lettingFee": {
      "amount": 0,
      "type": "percentage",
      "frequency": "notApplicable"
    },
    "_eTag": "\"4837E833BF1092AE8D26E7AFA98E1218\"",
    "startDate": "2023-02-25",
    "negotiatorId": "REDACTED",
    "status": "current"
  },
  "webhookAction": "tenancies.modified",
  "pmsPropertyId": "STM230001",
  "old": {
    "agentRole": "rentCollection",
    "arrears": {
      "paymentPlan": "no",
      "chaseArrears": true
    },
    "rentInstalmentsFrequency": "monthly",
    "endDate": "2025-02-24",
    "endDateConfirmed": false,
    "source": {
      "id": "SRC002",
      "type": "source"
    },
    "rent": REDACTED,
    "related": [
      {
        "title": "REDACTED",
        "type": "contact",
        "occupyOn": "2023-02-25",
        "forename": "REDACTED",
        "mobilePhone": "REDACTED",
        "surname": "REDACTED",
        "name": "REDACTED",
        "marketingConsent": "grant",
        "fromArchive": false,
        "id": "SML23000308",
        "primaryAddress": {
          "buildingName": "REDACTED",
          "line4": "",
          "postcode": "REDACTED",
          "buildingNumber": "REDACTED",
          "line3": "",
          "line2": "REDACTED",
          "line1": "REDACTED",
          "countryId": "GB"
        },
        "vacateOn": "2025-02-24",
        "email": "REDACTED"
      },
      {
        "paymentReference": "REDACTED",
        "title": "Mr",
        "type": "contact",
        "occupyOn": "2023-02-25",
        "forename": "REDACTED",
        "mobilePhone": "REDACTED",
        "surname": "REDACTED",
        "name": "REDACTED",
        "marketingConsent": "grant",
        "fromArchive": false,
        "id": "SML23000309",
        "primaryAddress": {
          "buildingName": "REDACTED",
          "line4": "",
          "postcode": "REDACTED",
          "buildingNumber": "REDACTED",
          "line3": "",
          "line2": "REDACTED",
          "line1": "REDACTED",
          "countryId": "GB"
        },
        "vacateOn": "REDACTED",
        "email": "REDACTED"
      }
    ],
    "modified": "2024-06-25T07:14:31Z",
    "id": "SML230021",
    "applicantId": "",
    "propertyId": "STM230001",
    "rentInstalmentsAmount": 1300,
    "rentFrequency": "monthly",
    "created": "2023-02-10T09:21:46Z",
    "isPeriodic": false,
    "managementFee": {
      "amount": REDACTED,
      "type": "percentage",
      "frequency": "monthly"
    },
    "fromArchive": false,
    "deposit": {
      "period": 5,
      "heldBy": "landlord",
      "sum": REDACTED,
      "type": "weeksRent"
    },
    "typeId": "RC",
    "lettingFee": {
      "amount": 0,
      "type": "percentage",
      "frequency": "notApplicable"
    },
    "_eTag": "\"C4D74383BF0464A1B7FC18302E34AF17\"",
    "startDate": "2023-02-25",
    "negotiatorId": "REDACTED",
    "status": "current"
  },
  "customerId": "TWN",
  "entityId": "SML230021",
  "webhookType": "reapit"
}

Screenshot of our configuration in Reapit Cloud Developer portal; reapit-cloud-twn

Philb40 commented 2 months ago

Hello

We are very keen to resolve this asap as it is having a sizeable impact on operations, can you assist?

Best Regards

*Book a Utility Management Consultation/Catch up direct in my diary using *This Link https://calendar.app.google/sWE9PbGcNQuLtXbP7

Platform/Support: @. / Referencing: @. Tel Support: 020 3198 2060. In app web chat also available now for both Sup. & Ref.

Phil Bensley

Senior Tenancy Services Manager

Direct Line: 0203 9000 861

[image: image.png]

Company Number:8933499 VAT:274970368

On Tue, 2 Jul 2024 at 11:38, Ollie Bennett @.***> wrote:

Hi @AshDeeming https://github.com/AshDeeming, sorry to re-open this.

We've been waiting for any webhooks to come through containing the new pOVOEnergy field, but none so far have had it.

I think it has been configured correctly, from what I can see (and your system rejects incorrect values here, suggesting pOVOEnergy is correct). Screenshot shared below.

Q: Is there an issue with the configuration or something on your side preventing the flag being sent? Q: Should we expect to see the field on every webhook, or will it only show if it was checked?

The following is an example of a webhook received for which the "Opt Out OVO Energy" checkbox IS ticked (just in case it only appears when checked). The payload unfortunately does NOT contain anything related to the checkbox;

  • Webhook received: Jun 25 12:43:53
  • Customer ID: TWN
  • Property ID: STM230001
  • Payload (redacted where appropriate):

{ "new": { "agentRole": "rentCollection", "rentInstalmentsFrequency": "monthly", "arrears": { "paymentPlan": "no", "chaseArrears": true }, "endDate": "2024-08-24", "endDateConfirmed": true, "source": { "id": "SRC002", "type": "source" }, "rent": REDACTED, "related": [ { "title": "REDACTED", "type": "contact", "occupyOn": "2023-02-25", "forename": "REDACTED", "mobilePhone": "REDACTED", "surname": "REDACTED", "name": "REDACTED", "marketingConsent": "grant", "fromArchive": false, "id": "SML23000308", "primaryAddress": { "buildingName": "REDACTED", "line4": "", "postcode": "REDACTED", "buildingNumber": "REDACTED", "line3": "", "line2": "REDACTED", "line1": "REDACTED", "countryId": "GB" }, "vacateOn": "2024-08-24", "email": "REDACTED" }, { "paymentReference": "REDACTED", "title": "REDACTED", "type": "contact", "occupyOn": "2023-02-25", "forename": "REDACTED", "mobilePhone": "REDACTED", "surname": "REDACTED", "name": "REDACTED", "marketingConsent": "grant", "fromArchive": false, "id": "SML23000309", "primaryAddress": { "buildingName": "REDACTED", "line4": "", "postcode": "REDACTED", "buildingNumber": "REDACTED", "line3": "", "line2": "REDACTED", "line1": "REDACTED", "countryId": "GB" }, "vacateOn": "2024-08-24", "email": "REDACTED" } ], "modified": "2024-06-25T11:43:50Z", "id": "SML230021", "applicantId": "", "propertyId": "STM230001", "rentInstalmentsAmount": 1300, "rentFrequency": "monthly", "created": "2023-02-10T09:21:46Z", "isPeriodic": false, "managementFee": { "amount": REDACTED, "type": "percentage", "frequency": "monthly" }, "deposit": { "period": 5, "heldBy": "landlord", "sum": REDACTED, "type": "weeksRent" }, "fromArchive": false, "typeId": "RC", "lettingFee": { "amount": 0, "type": "percentage", "frequency": "notApplicable" }, "_eTag": "\"4837E833BF1092AE8D26E7AFA98E1218\"", "startDate": "2023-02-25", "negotiatorId": "REDACTED", "status": "current" }, "webhookAction": "tenancies.modified", "pmsPropertyId": "STM230001", "old": { "agentRole": "rentCollection", "arrears": { "paymentPlan": "no", "chaseArrears": true }, "rentInstalmentsFrequency": "monthly", "endDate": "2025-02-24", "endDateConfirmed": false, "source": { "id": "SRC002", "type": "source" }, "rent": REDACTED, "related": [ { "title": "REDACTED", "type": "contact", "occupyOn": "2023-02-25", "forename": "REDACTED", "mobilePhone": "REDACTED", "surname": "REDACTED", "name": "REDACTED", "marketingConsent": "grant", "fromArchive": false, "id": "SML23000308", "primaryAddress": { "buildingName": "REDACTED", "line4": "", "postcode": "REDACTED", "buildingNumber": "REDACTED", "line3": "", "line2": "REDACTED", "line1": "REDACTED", "countryId": "GB" }, "vacateOn": "2025-02-24", "email": "REDACTED" }, { "paymentReference": "REDACTED", "title": "Mr", "type": "contact", "occupyOn": "2023-02-25", "forename": "REDACTED", "mobilePhone": "REDACTED", "surname": "REDACTED", "name": "REDACTED", "marketingConsent": "grant", "fromArchive": false, "id": "SML23000309", "primaryAddress": { "buildingName": "REDACTED", "line4": "", "postcode": "REDACTED", "buildingNumber": "REDACTED", "line3": "", "line2": "REDACTED", "line1": "REDACTED", "countryId": "GB" }, "vacateOn": "REDACTED", "email": "REDACTED" } ], "modified": "2024-06-25T07:14:31Z", "id": "SML230021", "applicantId": "", "propertyId": "STM230001", "rentInstalmentsAmount": 1300, "rentFrequency": "monthly", "created": "2023-02-10T09:21:46Z", "isPeriodic": false, "managementFee": { "amount": REDACTED, "type": "percentage", "frequency": "monthly" }, "fromArchive": false, "deposit": { "period": 5, "heldBy": "landlord", "sum": REDACTED, "type": "weeksRent" }, "typeId": "RC", "lettingFee": { "amount": 0, "type": "percentage", "frequency": "notApplicable" }, "_eTag": "\"C4D74383BF0464A1B7FC18302E34AF17\"", "startDate": "2023-02-25", "negotiatorId": "REDACTED", "status": "current" }, "customerId": "TWN", "entityId": "SML230021", "webhookType": "reapit" }

Screenshot of our configuration in Reapit Cloud Developer portal; reapit-cloud-twn.png (view on web) https://github.com/reapit/foundations/assets/1068525/e3a2ad20-6f09-4805-b49d-fc608c0addd2

— Reply to this email directly, view it on GitHub https://github.com/reapit/foundations/issues/11203#issuecomment-2202696583, or unsubscribe https://github.com/notifications/unsubscribe-auth/BJCG6PEI7UIJFNRNFQRVGULZKJ7J5AVCNFSM6AAAAABI6XHUCSVHI2DSMVQWIX3LMV43OSLTON2WKQ3PNVWWK3TUHMZDEMBSGY4TMNJYGM . You are receiving this because you were mentioned.Message ID: @.***>

--

Company Number:8933499  VAT:274970368 

Oh Goodlord Limited is an Appointed Representative of Goodlord Protect Limited for general insurance products and credit broking. Goodlord Protect Limited is directly authorised by the Financial Conduct Authority, registration number 836727. You can check this information on the Financial Services Register by visiting  www.fca.org.uk/register http://www.fca.org.uk/register or by telephoning 0800 111 6768 (Freephone) or 0300 500 8082 from the UK. The FCA is the independent watchdog that regulates financial services.

This message is intended solely for the addressee and may contain privileged and/or confidential information. Although we use industry-standard virus-checking software on our systems, the recipient should ensure that this email and attachments are virus-free before opening. If you have received this message in error, please contact us to let us know and delete it immediately. If you are not the intended recipient of this email, do not use, copy or disclose the information contained in this message or in any attachment.

AshDeeming commented 2 months ago

Hi @olliebennett The subscription topic selected is Tenancy Modified however this semi structured data is associated to Property records

AshDeeming commented 2 months ago

Hi @olliebennett Could you confirm the relevant subscription topic has been created/updated & working so we can close this ticket?

olliebennett commented 2 months ago

Hi @AshDeeming, thanks. Yes - we've got access to the pOVOEnergy boolean and have updated our system to request that extraField from the property endpoint and action it accordingly. You can close the issue - thanks again. Ollie

github-actions[bot] commented 2 months ago

It looks like you have commented on a closed issue. If your comment relates to a bug or feature request, please open a new issue, and include this issue number/url for reference. For more information on our processes, please click here