Skip to main content
This section covers all webhook events related to organisations, including organisation creation, updates, deletions, status changes, and user management.

​
Event Types

The following organisation-related events are available:
  • organisations.created - Triggered when an organisation is created
  • organisations.updated - Triggered when an organisation is updated
  • organisations.deleted - Triggered when an organisation is deleted
  • organisation_status.changed - Triggered when an organisation’s status changes
  • organisation_users.added - Triggered when a user is added to an organisation
  • organisation_users.deleted - Triggered when a user is removed from an organisation

​
Organisation Created Event

The organisations.created event is triggered when a new organisation is created in the system.

​
Event Structure

{
  "event_type": "organisations.created",
  "payload": {
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "company_name": "Acme Corporation",
    "contact_name": "John Doe",
    "organisation_number": "123456789",
    "credit_check": true,
    "email": "[email protected]",
    "invoice_email": "[email protected]",
    "custom_fields": {
      "industry": "Technology",
      "size": "Enterprise"
    },
    "phone": "+1-555-123-4567",
    "tax_id_vat": "US123456789",
    "external_ref": "EXT-001",
    "store_group_ids": [
      "123e4567-e89b-12d3-a456-426614174001",
      "123e4567-e89b-12d3-a456-426614174002"
    ],
    "shipping": [
      {
        "id": "123e4567-e89b-12d3-a456-426614174003",
        "name": "Main Warehouse",
        "company_name": "Acme Corporation",
        "street_address": "123 Business St",
        "co_address": "Suite 100",
        "city": "New York",
        "state_province": "NY",
        "house_number": "123",
        "zip_postal_code": "10001",
        "country": "US",
        "phone": "+1-555-123-4567",
        "is_default": true
      }
    ],
    "billing": [
      {
        "id": "123e4567-e89b-12d3-a456-426614174004",
        "name": "Billing Department",
        "company_name": "Acme Corporation",
        "street_address": "456 Finance Ave",
        "co_address": "Floor 5",
        "city": "New York",
        "state_province": "NY",
        "house_number": "456",
        "zip_postal_code": "10002",
        "country": "US",
        "phone": "+1-555-987-6543",
        "is_default": true
      }
    ],
    "status": "active",
    "attributes": [
      {
        "id": "123e4567-e89b-12d3-a456-426614174005",
        "name": "Industry Type",
        "description": "Type of industry",
        "key": "industry_type",
        "template_key": "industry_template",
        "values": {
          "industry_type": [
            {
              "id": "123e4567-e89b-12d3-a456-426614174006",
              "key": "technology",
              "type": "text",
              "value": "Technology",
              "translations": {
                "value": [
                  {
                    "country_code": "us",
                    "value": "Technology"
                  }
                ]
              }
            }
          ]
        },
        "translations": {
          "name": [
            {
              "country_code": "us",
              "value": "Industry Type"
            }
          ],
          "description": [
            {
              "country_code": "us",
              "value": "Type of industry"
            }
          ]
        },
        "filterable": true,
        "translatable": true,
        "created_at": "2024-02-12T12:00:00Z",
        "updated_at": "2024-02-12T12:00:00Z"
      }
    ],
    "tags": [
      {
        "id": "123e4567-e89b-12d3-a456-426614174007",
        "key": "enterprise",
        "name": "Enterprise",
        "translations": {
          "name": [
            {
              "country_code": "us",
              "value": "Enterprise"
            }
          ]
        },
        "filterable": true,
        "attributes": [],
        "created_at": "2024-02-12T12:00:00Z",
        "updated_at": "2024-02-12T12:00:00Z",
        "status": "active"
      }
    ]
  }
}

​
Field Descriptions

FieldTypeDescription
idstringUnique identifier for the organisation
company_namestringLegal name of the company
contact_namestringPrimary contact person name
organisation_numberstringOfficial registration number
credit_checkbooleanWhether credit check is enabled
emailstringPrimary contact email
invoice_emailstringEmail for invoice delivery
custom_fieldsobjectCustom key-value pairs
phonestringContact phone number
tax_id_vatstringTax identification number
external_refstringExternal reference identifier
store_group_idsarrayAssociated store group identifiers
shippingarrayShipping addresses
billingarrayBilling addresses
statusstringOrganisation status (one of: active, pending, inactive)
attributesarrayAssociated attributes
tagsarrayAssociated tags

​
Organisation Updated Event

The organisations.updated event is triggered when an organisation is modified. The structure is identical to the created event.

​
Event Structure

{
  "event_type": "organisations.updated",
  "payload": {
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "company_name": "Acme Corporation",
    "contact_name": "John Doe",
    "organisation_number": "123456789",
    "credit_check": true,
    "email": "[email protected]",
    "invoice_email": "[email protected]",
    "custom_fields": {
      "industry": "Technology",
      "size": "Enterprise"
    },
    "phone": "+1-555-123-4567",
    "tax_id_vat": "US123456789",
    "external_ref": "EXT-001",
    "store_group_ids": [
      "123e4567-e89b-12d3-a456-426614174001",
      "123e4567-e89b-12d3-a456-426614174002"
    ],
    "shipping": [
      {
        "id": "123e4567-e89b-12d3-a456-426614174003",
        "name": "Main Warehouse",
        "company_name": "Acme Corporation",
        "street_address": "123 Business St",
        "co_address": "Suite 100",
        "city": "New York",
        "state_province": "NY",
        "house_number": "123",
        "zip_postal_code": "10001",
        "country": "US",
        "phone": "+1-555-123-4567",
        "is_default": true
      }
    ],
    "billing": [
      {
        "id": "123e4567-e89b-12d3-a456-426614174004",
        "name": "Billing Department",
        "company_name": "Acme Corporation",
        "street_address": "456 Finance Ave",
        "co_address": "Floor 5",
        "city": "New York",
        "state_province": "NY",
        "house_number": "456",
        "zip_postal_code": "10002",
        "country": "US",
        "phone": "+1-555-987-6543",
        "is_default": true
      }
    ],
    "status": "active",
    "attributes": [
      {
        "id": "123e4567-e89b-12d3-a456-426614174005",
        "name": "Industry Type",
        "description": "Type of industry",
        "key": "industry_type",
        "template_key": "industry_template",
        "values": {
          "industry_type": [
            {
              "id": "123e4567-e89b-12d3-a456-426614174006",
              "key": "technology",
              "type": "text",
              "value": "Technology",
              "translations": {
                "value": [
                  {
                    "country_code": "us",
                    "value": "Technology"
                  }
                ]
              }
            }
          ]
        },
        "translations": {
          "name": [
            {
              "country_code": "us",
              "value": "Industry Type"
            }
          ],
          "description": [
            {
              "country_code": "us",
              "value": "Type of industry"
            }
          ]
        },
        "filterable": true,
        "translatable": true,
        "created_at": "2024-02-12T12:00:00Z",
        "updated_at": "2024-02-12T12:00:00Z"
      }
    ],
    "tags": [
      {
        "id": "123e4567-e89b-12d3-a456-426614174007",
        "key": "enterprise",
        "name": "Enterprise",
        "translations": {
          "name": [
            {
              "country_code": "us",
              "value": "Enterprise"
            }
          ]
        },
        "filterable": true,
        "attributes": [],
        "created_at": "2024-02-12T12:00:00Z",
        "updated_at": "2024-02-12T12:00:00Z",
        "status": "active"
      }
    ]
  }
}

​
Organisation Deleted Event

The organisations.deleted event is triggered when an organisation is removed from the system.

​
Event Structure

{
  "event_type": "organisations.deleted",
  "payload": {
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "org_number": "1234-1234"
  }
}

​
Field Descriptions

FieldTypeDescription
idstringUnique identifier of the deleted organisation

​
Organisation Status Changed Event

The organisation_status.changed event is triggered when an organisation’s status changes (e.g., from active to inactive, pending to active, etc.).

​
Event Structure

{
  "event_type": "organisation_status.changed",
  "payload": {
    "organisation_id": "123e4567-e89b-12d3-a456-426614174000",
    "org_number": "123456789",
    "to_status": "inactive",
    "old_status": "active"
  }
}

​
Field Descriptions

FieldTypeDescription
organisation_idstringUnique identifier of the organisation
org_numberstringOrganisation registration number
to_statusstringNew status of the organisation (one of: active, pending, inactive)
old_statusstringPrevious status of the organisation (one of: active, pending, inactive)

​
Organisation User Added Event

The organisation_users.added event is triggered when a user is added to an organisation.

​
Event Structure

{
  "event_type": "organisation_users.added",
  "payload": {
    "organisation_id": "123e4567-e89b-12d3-a456-426614174000",
    "user_id": "123e4567-e89b-12d3-a456-426614174008",
    "role": "admin",
    "level": "admin"
  }
}

​
Field Descriptions

FieldTypeDescription
organisation_idstringUnique identifier of the organisation
user_idstringUnique identifier of the user
rolestringUser’s role in the organisation
levelstringUser’s access level (admin, default)

​
Organisation User Deleted Event

The organisation_users.deleted event is triggered when a user is removed from an organisation.

​
Event Structure

{
  "event_type": "organisation_users.deleted",
  "payload": {
    "organisation_id": "123e4567-e89b-12d3-a456-426614174000",
    "user_id": "123e4567-e89b-12d3-a456-426614174008",
    "role": "admin",
    "level": "admin"
  }
}

​
Field Descriptions

FieldTypeDescription
organisation_idstringUnique identifier of the organisation
user_idstringUnique identifier of the removed user
rolestringUser’s role at time of removal
levelstringUser’s access level at time of removal