Business events

The table below lists the Webhook events for business.

EventDescription
business.invitedTriggered when a business is created and invitation has been sent.
business.updatedTriggered when a business is updated.

business.invited | business.updated

Below payload is dispatched on business creation or updation. Each event will have the business object.

The update event will dispatch the whole business even if only few fields for a business are updated

{

  "event_type": "business.invited | business.updated",

  "payload": {

    "id": "81c92b78-9ce1-4ba0-9557-6dce4a5ccbdb",

    "name": "XYZ BIZ",

    "tin": "XXXXX7204",

    "address_apartment": null,

    "address_line_1": "3614, Cassopolis Street,",

    "address_line_2": null,

    "address_city": "Elkhart",

    "address_state": "Indiana",

    "address_postal_code": "46514",

    "address_country": "USA",

    "created_at": "2024-08-01T09:24:36.049Z",

    "created_by": "dc2bf5c0-8c39-41aa-b1f2-658991a0deb2",

    "updated_at": "2024-08-01T09:40:40.605Z",

    "updated_by": "846ced9e-45ff-44fe-b180-0a54ec1dc5cb",

    "mobile": null,

    "official_website": null,

    "public_website": null,

    "social_account": null,

    "status": "VERIFIED",

    "naics_code": null,

    "naics_title": null,

    "industry": {

      "id": 1,

      "name": "Agriculture, Forestry, Fishing and Hunting",

      "code": "agriculture_forestry_fishing_and_hunting",

      "sector_code": "11",

      "created_at": "2024-04-24T17:56:46.034418",

      "updated_at": "2024-04-24T17:56:46.034418"

    },

    "is_monitoring_enabled": true,

    "subscription": {

      "status": "SUBSCRIBED",

      "created_at": "2024-08-01T09:42:20.686Z",

      "updated_at": "2024-09-01T10:45:54.972Z"

    },

    "business_names": [

      {

        "name": "XYZ BIZ",

        "is_primary": true

      }

    ],

    "business_addresses": [

      {

        "line_1": "3614, Cassopolis Street,",

        "apartment": null,

        "city": "Elkhart",

        "state": "Indiana",

        "country": "USA",

        "postal_code": "46514",

        "mobile": null,

        "is_primary": true

      }

    ]

  }

}

Was this page helpful?