Webhooks Info

Before you begin...

Webhooks are technical in nature and require an understanding of JSON data structures and API configuration. If you are not familiar with these things, this is probably not the option you want to use.

What are Webhooks?

A webhook is a way for an app to provide other applications with real-time information. A webhook delivers data to other applications as it happens based on events in the source system.

What do we need from you?

In order to receive webhook notifications from GroupTrack, you will need to provide an endpoint URL capable of receiving and processing the data we send. This could be your own private/cloud server, or a platform/service capable of receiving and processing webhook notifications.

How does this work?

Your endpoint will need to respond to our POST notifications with a "200" status code. It is not necessary to send any data back to us, and if you do it will simply be ignored.

Here is an up-to-date definition of the JSON payload we provide:

{
    "event": "info/note/stage/tag/task",
    "action": "add/update/delete",
    "fullName": "First Last",
    "firstName":  "First",
    "lastName": "Last",
    "emailAddress": "[email protected]",
    "oldEmailAddress": "Previous Email if changed",
    "phoneNumber": "000-000-0000",
    "fbUsername": "FB-Username",
    "profileID": "GT-Profile-ID",
    "globalTags": "comma,separated,list,of,global,tags",
    "stage": "Current Stage if included",
    "tags": [{
        "tagSetName": "Name of the Group Tag Set (category)",
        "tag": "Tag Value"
    }],
    "tasks": [{
        "assignedTo": "Team Member Name",
        "assignedToUID": "ID of Team Member",
        "createdBy": "Team Member who created the Task",
        "isComplete": "boolean",
        "notificationDate": "Due date for the Task",
        "notificationType": "email/sms/app",
        "setTime": "boolean (otherwise notificationDate is the default 8 am on selected date)",
        "taskName": "Description of the Task"
    }],
    "notes": [{
        "createdAt": "Date the note was created",
        "createdBy": "Team Member who created the Note",
        "note": "Content of the Note",
        "type": "note"
    }]
}

Options for what gets synced

Group Additions: When Contacts are added to this Group in GroupTrack
Tags: Any Group Tag updates (add or delete)
Notes: Note type Activities
Stages: When you update a Stage for a Contact
Tasks: When you create or complete a Task
Contact Info: When you update the email or phone number for a Contact