Customers that need to re-authenticate their accounts
Once Bayou determines that customer data cannot be accessed, a customer_must_reauthenticate webhook is sent. This happens either because a customer's utility credentials are no longer valid or their multi-factor authentication challenge must be completed again.
{
"event": "customer_must_reauthenticate",
"object": {
"id": 12345,
"external_id": "MSCOTT123",
"reason": "credentials_are_invalid",
"onboarding_token": "ABCDEF0123456_ABCDEF0123456_ABCDEF0123456",
"onboarding_link": "https://bayou.energy/companies/12345/sign_up?key=ABCDEF0123456"
}
}
Within the webhook body you can use either the onboarding_url or onboarding_token (if you're using Bayou's embedded component) to direct the customer to re-authenticate their utility account.
After the customer has re-authenticated, the customer_has_filled_credentials and webhooks for any new data will be sent.
- New bill data will be indicated either by the new_bill or new_unparsed_bill webhooks.
- New interval data will be indicated by the new_intervals webhook
Updated about 1 year ago