Webhooks

You can use Webhooks to subscribe to certain events when they occur. Webhooks provide a way to respond to real-time events as they happen without having to constantly poll the API. When an event occurs that matches your webhook scope, a POST HTTP request will be sent to your webhook URL.

Scopes

Projects:

Scope	Description
project.created	Fires when a project is created.
project.updated	Fires when a project is updated.
project.deleted	Fires when a project is deleted.
project.date.updated	Fires when any dates of a project is updated.
project.linked	Fires when a project gets linked.
project.financialkpi	Fires when financial KPI is updated
project.status.updated	Fires when a project status changed.

Tasks:

Scope	Description
task.created	Fires when a task is created.
task.updated	Fires when a task is updated.
task.deleted	Fires when a task is updated.
task.in-progress	Fires when a task is started.
task.completed	Fires when a task is completed.

Contacts:

Scope	Description
contact.created	Fires when a contact is created.
contact.updated	Fires when a contact is updated.
contact.deleted	Fires when a contact is deleted.

Organizations:

Scope	Description
organization.created	Fires when an organization is created.
organization.updated	Fires when an organization is updated.
organization.deleted	Fires when an organization is deleted.

Relationship Activities:

Scope	Description
relationship.activity.created	Fires when a relationship activity is created.
relationship.activity.updated	Fires when a relationship activity is updated.
relationship.activity.deleted	Fires when a relationship activity is deleted.

Scheduler:

Scope	Description
schedule.event.created	Fires when a scheduled event is created.

Albi Project Payments:

Scope	Description
{project.payments.created}	Fires when a project payment is created.
{project.payments.update}	Fires when a project payment is updated.
{project.payments.deleted}	Fires when a project payment is deleted.
{project.payments.void}	Fires when any dates of a project payment is voided.

Expenses:

Scope	Description
{project.expenses.created}	Fires when a project expense is created.
{project.expenses.update}	Fires when a project expense is updated.
{project.expenses.deleted}	Fires when a project expense is deleted.
{project.expenses.void}	Fires when any dates of a project expense is voided.

Payload

Webhook notifications are POSTs with a JSON body. The response body contains the following fields:

JSON

{
    "Entity": "project",
    "EntityId": 1,
    "Scope": "project.created"
}

Field	Description
Entity	The name of the entity that changed (project, contact, etc.)
EntityId	The ID of the changed entity
Scope	The scope of change