Push Notifications - Partners Only

Endpoint

Overview:

BBB Partners have the need to be notified when BBB data updates occur for the records or a collection of records they are currently subscribed to.

Usage Scenarios:

  1. Rating Changes for an organization
  2. Accreditation Status changes for an organization
  3. If a record has changed in any way in a collection they are subscribed to or manage (see collections).

Partner Implementation

To receive real time updates of Organization changes you will need to do the following:

  1. Create a collection with the organizations to receive updates on as documented in “Collections Management Endpoint”.
  2. Set up an endpoint that accepts the organization updates
    1. The endpoint should accept an organization message.
    2. The JSON will be posted (HTTP POST) to your endpoint.
    3. You must register the URL of your endpoint with Council.  This URL will be mapped to a collection id, so you must decide which organization changes you want to accept with your endpoint.  Work directly with Council’s IT contact to establish a mapping between collection and URL.

Request Structure

Fields and Descriptions

Organization fields to returnData TypeDescription

BusinessId

string

Internal id of an organization. This is only unique across BBBs/Bureaus. The BusinessId plus the BBBID will make a unique record.

OrganizationType

string

Type of organization.

BBBId

string

Internal identifier of a regional BBB

BBBRating

string

Letter grade rating of organization

Valid values:

A, A+, A-, B, B+, B-, C, C+, C-, D, D+, D-, F,NA, NR

IsBBBAccredited

boolean

Is organization accredited?

IsReportable

boolean

Is organization reported on the public web site?

PrimaryOrganizationName

string

Name designated as primary

AltOrganizationNames

list of strings

List of alternate organization names.

PrimaryCategory

string

Category designated as primary

ContactFirstName

string

First name of primary contact

ContactLastName

string

Last name of primary contact

ContactMiddleName

string

Middle name of primary contact

ContactTitle

string

Title of primary contact

ContactPrefix

string

Prefix of primary contact

Address

string

Street address

City

string

City

StateProvince

string

State or province

PostalCode

string

Postal/Zip code

Phones

list of strings

All phone numbers that are associated with an organization

BusinessURLs

list of strings

All URLs that are associated with an organization

ReportURL

string

URL to the organization's BBB Business Review. Suppressed if the Organization's "IsReportable" flag is false.

OrganizationLastChanged

date/time

Date/time value that indicates when any field on an organization was last changed.

RatingLastChanged

date/time

Date/time value that indicates when the rating grade for an organization was last changed.

AccreditationStatusLastChanged

date/time

Date/time value that indicates when the accreditation status for an organization was last changed.

Examples

Add/Remove a Category(s)

Documented in “Collections Management Endpoint”

Add/Remove an Organization(s)

Documented in “Collections Management Endpoint”

Delete a Collection

Documented in “Collections Management Endpoint”

Responses

Documented in “Collections Management Endpoint”

Errors/Status

Documented in “Collections Management Endpoint”

Additional Notes