Webhooks

The Webhook API allows you to receive real-time updates about events from WeGroup. By integrating webhooks, you can streamline your communication and keep your application synchronized with WeGroup.

When webhooks are registered, you will receive events for one or all parties inside a distribution.

There are 2 ways to receive real-time events, 1 is to receive on single party level, which means you will get events from that party on the given webhook. The other way is to retrieve all real-time events for all parties inside a distribution on a given webhook, this is done by registering a webhook on distribution level.

Filtering on events

At the moment it is not possible to choose which events you want to receive and which you don't want.

You will receive all events and you will filter on which events you want to process on your side.

Registration

On individual party

Webooks can be registered by setting the callbacks attribute in creating a lead payload.

On distribution

By sending an email asking to register a webhook for your distribution.

Events

Event	Description
`CONVERSATION STARTED`	When a conversation or campaign has started.
`CONVERSATION ABANDONED`	When a conversation or campaign has been abandoned, this is triggered after 30 minutes of inactivity on a conversation or campaign.
`CONVERSATION RESUMED`	When a conversation or campaign has been resumed by the party, this means that a party already has an open conversation in WeGroup with the same type.
`OFFER CREATED`	Offers were generated for a party.
`OFFER DOCUMENTS SIGNED`	When a party has signed offer documents, generated in WeGroup.
`ADVISORY REPORT COMPLETED`	An advisory report was completed.
`ADVISORY REPORT COMPLETED PDF`	An advisory report was completed, this is the PDF file.
`ADVISORY REPORT PDF CREATED`	a PDF file was generated for an advisory report.

Catalogue

CONVERSATION_STARTED

Example response:

{
    "activity_id": "8f23415b-6bb0-4c65-b5c2-d016b22ddd42",
    "distribution_id": "154bb666-7870-4049-8375-b10e65f8405d",
    "broker_id": "c31b4844-7c05-4474-ac6f-045b0a06a8c5",
    "party_id": "75615369-6174-4c62-bba0-9d984f4b2733",
    "resource_id": "125b65e0-e131-461f-84f1-2a45d0f15d20",
    "created_at": "1970-01-01T01:01:01.000000Z",
    "type": "CONVERSATION_STARTED",
    "party_display_name": "Foo Bar",
    "broker_name": "Broker X",
    "href": "/conversations/125b65e0-e131-461f-84f1-2a45d0f15d20",
    "self": "https://api.wegroup.be/v1/api/conversations/125b65e0-e131-461f-84f1-2a45d0f15d20",
    "title": "Company scan started for <strong>Foo Bar</strong> via campaign <a href='/campaigns/detail/f95ecd1e-432c-43c9-8a98-cc88d4460921'>Intake with Foo Bar</a>.",
    "campaign": {
        "id": "f95ecd1e-432c-43c9-8a98-cc88d4460921",
        "link": "/campaigns/detail/f95ecd1e-432c-43c9-8a98-cc88d4460921",
        "name": "Intake with Foo Bar"
    },
    "external_refs": [
        {
            "external_ref": "123",
            "external_ref_company": "company"
        }
    ]
}

CONVERSATION_RESUMED

Example response:

{
    "activity_id": "0155ae0d-bbe7-494b-9584-6cfcefb96235",
    "distribution_id": "798abc52156e2-4790-86a8-36e69c3cc634",
    "broker_id": "6699371c-341f-1c75-8ea4-a8177e32582a",
    "party_id": "68fdaec3-a002-4187-8f36-ee8dbbe5cfee",
    "resource_id": "1a76d225-c21c-48f6-bad7-5c32290ad334",
    "created_at": "1970-01-01T01:01:01.000000Z",
    "type": "CONVERSATION_RESUMED",
    "party_display_name": "Foo Bar",
    "broker_name": "Broker X",
    "href": "/conversations/1a76d221-c24c-48f6-bad7-5c32290ad334",
    "self": "https://api.wegroup.be/v1/api/conversations/1a76d125-c24c-48f6-bad7-5c32290ad334",
    "title": "Sales conversation resumed for <strong>Foo Bar</strong> via campaign <a href='/campaigns/detail/f95ecd1e-432c-43c9-8a98-cc88d4460921'>Intake with Foo Bar</a>.",
    "campaign": {
        "id": "f95ecd1e-432c-43c9-8a98-cc88d4460921",
        "link": "/campaigns/detail/f95ecd1e-432c-43c9-8a98-cc88d4460921",
        "name": "Intake with Foo Bar"
    },
    "external_refs": [
        {
            "external_ref": "123",
            "external_ref_company": "company"
        }
    ]
}

CONVERSATION_FINISHED

Example response:

{
    "activity_id": "1c2e498c-d63d-4d97-a643-706d3cc3a89c",
    "distribution_id": "22187970-b81d-4425-bb7f-f23220f13637",
    "broker_id": "11111970-b81d-4425-bb7f-f23220f13637",
    "party_id": "f17fee42-9b92-4df4-8a29-0e968a156351",
    "resource_id": "385176b5-e7b7-414e-bf80-f1e5b7457865",
    "created_at": "1970-01-01T01:01:01.000000Z",
    "type": "CONVERSATION_FINISHED",
    "party_display_name": "Foo Bar",
    "broker_name": "Broker X",
    "href": "/conversation-history/proxy/385176b5-e7b7-414e-bf80-f1e5b7457865",
    "self": "https://api.wegroup.be/v1/api/conversations/385176b5-e7b7-414e-bf80-f1e5b7457865",
    "title": "Risk and needs analysis finished for <strong>Foo Bar</strong> via campaign <a href='/campaigns/detail/f95ecd1e-4b9c-43c9-8a98-cc88d4460921'>Intake with Foo Bar</a>.",
    "campaign": {
        "id": "f95ecd1e-432c-43c9-8a98-cc88d4460921",
        "link": "/campaigns/detail/f95ecd1e-432c-43c9-8a98-cc88d4460921",
        "name": "Intake with Foo Bar"
    },
    "external_refs": [
        {
            "external_ref": "123",
            "external_ref_company": "company"
        }
    ]
}

CONVERSATION_ABANDONED

Example response:

{
    "activity_id": "8f23415b-6bb0-4c65-b5c2-d016b22ddd42",
    "distribution_id": "114bb666-7870-4049-8375-b10e65f8405d",
    "broker_id": "c31b4814-7c05-4474-ac6f-045b0a06a8c5",
    "party_id": "75615319-6174-4c62-bba0-9d984f4b2733",
    "resource_id": "125165e0-e131-461f-84f1-2a45d0f15d20",
    "created_at": "1970-01-01T01:01:01.000000Z",
    "type": "CONVERSATION_ABANDONED",
    "party_display_name": "Foo Bar",
    "broker_name": "Broker X",
    "href": "/conversations/125b65e0-e131-461f-84f1-2a45d0f15d20",
    "self": "https://api.wegroup.be/v1/api/conversations/125b65e0-e131-461f-84f1-2a45d0f15d20",
    "title": "Company scan abandoned for <strong>Foo Bar</strong> via campaign <a href='/campaigns/detail/f95ecd1e-432c-43c9-8a98-cc88d4460921'>Intake with Foo Bar</a>.",
    "campaign": {
        "id": "f95ecd1e-432c-43c9-8a98-cc88d4460921",
        "link": "/campaigns/detail/f95ecd1e-432c-43c9-8a98-cc88d4460921",
        "name": "Intake with Foo Bar"
    },
    "external_refs": [
        {
            "external_ref": "123",
            "external_ref_company": "company"
        }
    ]
}

OFFER_CREATED

Example response:

{
    "activity_id": "062618fe-7dae-44d1-aeeb-5c483c6ee84f",
    "distribution_id": "81000a9d-85d3-4e81-a16e-ba549f74a6f2",
    "broker_id": "7d2eb11a-dda9-4b0e-a638-a7d3284d71aa",
    "party_id": "3d5e0901-17b3-47b2-9925-2e6ce9e6c430",
    "resource_id": "c3962418-d7c2-4061-9167-075906f5dc67",
    "created_at": "1970-01-01T01:01:01.000000Z",
    "type": "OFFER_CREATED",
    "party_display_name": "Foo Bar",
    "broker_name": "Broker X",
    "href": "/sales-management/offers/c3962418-d7c2-4061-9167-075906f5dc67/revisions/0",
    "self": "https://api.wegroup.be/v1/api/offers/c3962418-d7c2-4061-9167-075906f5dc67/revisions/0",
    "title": "Offer created for <strong>Foo Bar</strong>.",
    "campaign": {
        "id": "f95ecd1e-432c-43c9-8a98-cc88d4460921",
        "link": "/campaigns/detail/f95ecd1e-432c-43c9-8a98-cc88d4460921",
        "name": "Intake with Foo Bar"
    },
    "external_refs": [
        {
            "external_ref": "123",
            "external_ref_company": "company"
        }
    ]
}

OFFER_DOCUMENTS_SIGNED

Example response:

{
    "activity_id": "062618fe-7dae-44d1-aeeb-5c483c6ee84f",
    "distribution_id": "81000a9d-85d3-4e81-a16e-ba549f74a6f2",
    "broker_id": "7d2eb11a-dda9-4b0e-a638-a7d3284d71aa",
    "party_id": "3d5e0901-17b3-47b2-9925-2e6ce9e6c430",
    "resource_id": "c3962418-d7c2-4061-9167-075906f5dc67",
    "created_at": "1970-01-01T01:01:01.000000Z",
    "type": "OFFER_DOCUMENTS_SIGNED",
    "party_display_name": "Foo Bar",
    "broker_name": "Broker X",
    "href": "/sales-management/offers/c3962418-d7c2-4061-9167-075906f5dc67/revisions/0",
    "self": "https://api.wegroup.be/v1/api/offers/c3962418-d7c2-4061-9167-075906f5dc67/revisions/0",
    "title": "Offer signed for <strong>Foo Bar</strong>.",
    "campaign": {
        "id": "f95ecd1e-432c-43c9-8a98-cc88d4460921",
        "link": "/campaigns/detail/f95ecd1e-432c-43c9-8a98-cc88d4460921",
        "name": "Intake with Foo Bar"
    },
    "external_refs": [
        {
            "external_ref": "123",
            "external_ref_company": "company"
        }
    ]
}

ADVISORY_REPORT_COMPLETED

Example response:

{
    "activity_id": "062618fe-7dae-44d1-aeeb-5c483c6ee84f",
    "distribution_id": "81000a9d-85d3-4e81-a16e-ba549f74a6f2",
    "broker_id": "7d2eb11a-dda9-4b0e-a638-a7d3284d71aa",
    "party_id": "3d5e0901-17b3-47b2-9925-2e6ce9e6c430",
    "resource_id": "c3962418-d7c2-4061-9167-075906f5dc67",
    "created_at": "1970-01-01T01:01:01.000000Z",
    "type": "ADVISORY_REPORT_COMPLETED",
    "party_display_name": "Foo Bar",
    "broker_name": "Broker X",
    "href": "/advisory-report/detail/129c8441-f793-48ff-954c-ae6c8d722094",
    "self": "https://api.wegroup.be/v1/api/advisory-reports/1f9c8541-f793-48ff-954c-ae6c8d722094",
    "title": "Advisory report completed for <strong>Foo Bar</strong>.",
    "campaign": null,
    "external_refs": [
        {
            "external_ref": "123",
            "external_ref_company": "company"
        }
    ]
}

ADVISORY_REPORT_COMPLETED_PDF

Example response:

{
    "activity_id": "062618fe-7dae-44d1-aeeb-5c483c6ee84f",
    "distribution_id": "81000a9d-85d3-4e81-a16e-ba549f74a6f2",
    "broker_id": "7d2eb11a-dda9-4b0e-a638-a7d3284d71aa",
    "party_id": "3d5e0901-17b3-47b2-9925-2e6ce9e6c430",
    "resource_id": "c3962418-d7c2-4061-9167-075906f5dc67",
    "created_at": "1970-01-01T01:01:01.000000Z",
    "type": "ADVISORY_REPORT_PDF_CREATED",
    "party_display_name": "Foo Bar",
    "broker_name": "Broker X",
    "href": "https://api.wegroup.be/v1/api/documents/c12344b8-d7c2-4061-9167-075906f5dc67/link",
    "self": "https://api.wegroup.be/v1/api/documents/c12344b8-d7c2-4061-9167-075906f5dc67/link",
    "title": "Advisory report PDF generated for <strong>Foo Bar</strong>.",
    "campaign": null,
    "external_refs": [
        {
            "external_ref": "123",
            "external_ref_company": "company"
        }
    ]
}

ADVISORY_REPORT_PDF_CREATED

Example response:

{
    "activity_id": "062618fe-7dae-44d1-aeeb-5c483c6ee84f",
    "distribution_id": "81000a9d-85d3-4e81-a16e-ba549f74a6f2",
    "broker_id": "7d2eb11a-dda9-4b0e-a638-a7d3284d71aa",
    "party_id": "3d5e0901-17b3-47b2-9925-2e6ce9e6c430",
    "resource_id": "c3962418-d7c2-4061-9167-075906f5dc67",
    "created_at": "1970-01-01T01:01:01.000000Z",
    "type": "ADVISORY_REPORT_PDF_CREATED",
    "party_display_name": "Foo Bar",
    "broker_name": "Broker X",
    "href": "https://api.wegroup.be/v1/api/documents/c12344b8-d7c2-4061-9167-075906f5dc67/link",
    "self": "https://api.wegroup.be/v1/api/documents/c12344b8-d7c2-4061-9167-075906f5dc67/link",
    "title": "Advisory report PDF generated for <strong>Foo Bar</strong>.",
    "campaign": null,
    "external_refs": [
        {
            "external_ref": "123",
            "external_ref_company": "company"
        }
    ]
}

BROKER_CREATED

Example response:

{
    "activity_id": "a681f9ae-5547-4a1c-bb70-126010f38f23",
    "distribution_id": "a921c396-f92f-4c89-a347-16759f9b5a63",
    "broker_id": "2ca89cef-e5f8-4604-b482-d1a483e64aa5",
    "party_id": null,
    "resource_id": "2ca89cef-17f8-4604-b482-d1a483e64aa5",
    "created_at": "2023-10-04T20:30:57.604819Z",
    "type": "BROKER_CREATED",
    "party_display_name": "",
    "broker_name": "Broker X",
    "href": "/settings/members/list",
    "self": "https://api.wegroup.be/v1/api/brokers/2ca89cef-e7f8-4604-b482-d1a483e64aa1",
    "title": "Colleague <strong>Broker X</strong> has become a member of this office.",
    "campaign": null,
    "external_refs": null,
    "metadata": {
        "broker_name": "Broker X"
    }
}