Svix

Uniform Webhook Event Types

This is the list of event types that we currently send. For guidance on how to listen to these events, take a look at Svix's guide to consuming webhooks.

composition.changed

Triggers when a composition has been changed.

Example
JSON
{
  "api_url": "https://uniform.app/api/v1/canvas?projectId=644ede73-d6aa-4159-bf98-14ad7fb4cb66&compositionId=0b9d2118-f2d0-4fe6-9d46-7c661abaf474&state=64",
  "edge_url": "https://uniform.global/api/v1/compositions?projectId=644ede73-d6aa-4159-bf98-14ad7fb4cb66&compositionId=0b9d2118-f2d0-4fe6-9d46-7c661abaf474&state=64",
  "edit_url": "https://uniform.app/projects/644ede73-d6aa-4159-bf98-14ad7fb4cb66/dashboards/canvas/edit/0b9d2118-f2d0-4fe6-9d46-7c661abaf474",
  "id": "0b9d2118-f2d0-4fe6-9d46-7c661abaf474",
  "name": "About Us",
  "project": {
    "id": "644ede73-d6aa-4159-bf98-14ad7fb4cb66",
    "url": "https://uniform.app/projects/644ede73-d6aa-4159-bf98-14ad7fb4cb66"
  },
  "slug": "/about-us",
  "state": 64,
  "trigger": {
    "id": "a7bce3da-9727-4ca8-b95b-57f731445c3f",
    "type": "release"
  },
  "type": "page"
}

composition.deleted

Triggers when a composition has been deleted.

Example
JSON
{
  "id": "0b9d2118-f2d0-4fe6-9d46-7c661abaf474",
  "name": "About Us",
  "project": {
    "id": "644ede73-d6aa-4159-bf98-14ad7fb4cb66",
    "url": "https://uniform.app/projects/644ede73-d6aa-4159-bf98-14ad7fb4cb66"
  },
  "slug": "/about-us",
  "state": 64,
  "trigger": {
    "id": "a7bce3da-9727-4ca8-b95b-57f731445c3f",
    "type": "release"
  },
  "type": "page"
}

composition.published

Triggers when a composition has been published.

Example
JSON
{
  "api_url": "https://uniform.app/api/v1/canvas?projectId=644ede73-d6aa-4159-bf98-14ad7fb4cb66&compositionId=0b9d2118-f2d0-4fe6-9d46-7c661abaf474&state=64",
  "edge_url": "https://uniform.global/api/v1/compositions?projectId=644ede73-d6aa-4159-bf98-14ad7fb4cb66&compositionId=0b9d2118-f2d0-4fe6-9d46-7c661abaf474&state=64",
  "edit_url": "https://uniform.app/projects/644ede73-d6aa-4159-bf98-14ad7fb4cb66/dashboards/canvas/edit/0b9d2118-f2d0-4fe6-9d46-7c661abaf474",
  "id": "0b9d2118-f2d0-4fe6-9d46-7c661abaf474",
  "name": "About Us",
  "project": {
    "id": "644ede73-d6aa-4159-bf98-14ad7fb4cb66",
    "url": "https://uniform.app/projects/644ede73-d6aa-4159-bf98-14ad7fb4cb66"
  },
  "slug": "/about-us",
  "state": 64,
  "trigger": {
    "id": "a7bce3da-9727-4ca8-b95b-57f731445c3f",
    "type": "release"
  },
  "type": "page"
}

composition.release.changed

Triggers when a composition has been changed or copied to a pre-launch release.

Example
JSON
{
  "api_url": "https://uniform.app/api/v1/canvas?projectId=644ede73-d6aa-4159-bf98-14ad7fb4cb66&compositionId=0b9d2118-f2d0-4fe6-9d46-7c661abaf474&state=64&releaseId=48293345-f2d0-1125-afda-7c661abad432",
  "edge_url": "https://uniform.global/api/v1/compositions?projectId=644ede73-d6aa-4159-bf98-14ad7fb4cb66&compositionId=0b9d2118-f2d0-4fe6-9d46-7c661abaf474&state=64&releaseId=48293345-f2d0-1125-afda-7c661abad432",
  "edit_url": "https://uniform.app/projects/644ede73-d6aa-4159-bf98-14ad7fb4cb66/dashboards/canvas/edit/0b9d2118-f2d0-4fe6-9d46-7c661abaf474?release=48293345-f2d0-1125-afda-7c661abad432",
  "id": "0b9d2118-f2d0-4fe6-9d46-7c661abaf474",
  "name": "About Us",
  "project": {
    "id": "644ede73-d6aa-4159-bf98-14ad7fb4cb66",
    "url": "https://uniform.app/projects/644ede73-d6aa-4159-bf98-14ad7fb4cb66"
  },
  "release": {
    "id": "48293345-f2d0-1125-afda-7c661abad432",
    "url": "https://uniform.app/projects/644ede73-d6aa-4159-bf98-14ad7fb4cb66/releases/48293345-f2d0-1125-afda-7c661abad432"
  },
  "slug": "/about-us",
  "state": 64,
  "type": "page"
}

composition.release.deleted

Triggers when a composition is deleted that is attached to a pre-launch release.

Example
JSON
{
  "id": "0b9d2118-f2d0-4fe6-9d46-7c661abaf474",
  "name": "About Us",
  "project": {
    "id": "644ede73-d6aa-4159-bf98-14ad7fb4cb66",
    "url": "https://uniform.app/projects/644ede73-d6aa-4159-bf98-14ad7fb4cb66"
  },
  "release": {
    "id": "48293345-f2d0-1125-afda-7c661abad432",
    "url": "https://uniform.app/projects/644ede73-d6aa-4159-bf98-14ad7fb4cb66/releases/48293345-f2d0-1125-afda-7c661abad432"
  },
  "slug": "/about-us",
  "state": 64,
  "type": "page"
}

composition.release.published

Triggers when a composition has been published that is attached to an pre-launch release.

Example
JSON
{
  "api_url": "https://uniform.app/api/v1/canvas?projectId=644ede73-d6aa-4159-bf98-14ad7fb4cb66&compositionId=0b9d2118-f2d0-4fe6-9d46-7c661abaf474&state=64?releaseId=48293345-f2d0-1125-afda-7c661abad432",
  "edge_url": "https://uniform.global/api/v1/compositions?projectId=644ede73-d6aa-4159-bf98-14ad7fb4cb66&compositionId=0b9d2118-f2d0-4fe6-9d46-7c661abaf474&state=64?releaseId=48293345-f2d0-1125-afda-7c661abad432",
  "edit_url": "https://uniform.app/projects/644ede73-d6aa-4159-bf98-14ad7fb4cb66/dashboards/canvas/edit/0b9d2118-f2d0-4fe6-9d46-7c661abaf474?release=48293345-f2d0-1125-afda-7c661abad432",
  "id": "0b9d2118-f2d0-4fe6-9d46-7c661abaf474",
  "name": "About Us",
  "project": {
    "id": "644ede73-d6aa-4159-bf98-14ad7fb4cb66",
    "url": "https://uniform.app/projects/644ede73-d6aa-4159-bf98-14ad7fb4cb66"
  },
  "release": {
    "id": "48293345-f2d0-1125-afda-7c661abad432",
    "url": "https://uniform.app/projects/644ede73-d6aa-4159-bf98-14ad7fb4cb66/releases/48293345-f2d0-1125-afda-7c661abad432"
  },
  "slug": "/about-us",
  "state": 64,
  "type": "page"
}

entry.changed

Triggers when an entry has been changed.

Example
JSON
{
  "api_url": "https://uniform.app/api/v1/entries?projectId=644ede73-d6aa-4159-bf98-14ad7fb4cb66&entryIDs=e5c95c60-314b-4700-9035-6f9c2a4ff800&state=64",
  "edge_url": "https://uniform.global/api/v1/entries?projectId=644ede73-d6aa-4159-bf98-14ad7fb4cb66&entryIDs=e5c95c60-314b-4700-9035-6f9c2a4ff800&state=64",
  "edit_url": "https://uniform.app/projects/644ede73-d6aa-4159-bf98-14ad7fb4cb66/dashboards/canvas/entries/e5c95c60-314b-4700-9035-6f9c2a4ff800",
  "id": "e5c95c60-314b-4700-9035-6f9c2a4ff800",
  "name": "About Us",
  "project": {
    "id": "644ede73-d6aa-4159-bf98-14ad7fb4cb66",
    "url": "https://uniform.app/projects/644ede73-d6aa-4159-bf98-14ad7fb4cb66"
  },
  "slug": "/about-us",
  "state": 64,
  "trigger": {
    "id": "a7bce3da-9727-4ca8-b95b-57f731445c3f",
    "type": "release"
  },
  "type": "page"
}

entry.deleted

Triggers when an entry has been deleted.

Example
JSON
{
  "id": "e5c95c60-314b-4700-9035-6f9c2a4ff800",
  "name": "About Us",
  "project": {
    "id": "644ede73-d6aa-4159-bf98-14ad7fb4cb66",
    "url": "https://uniform.app/projects/644ede73-d6aa-4159-bf98-14ad7fb4cb66"
  },
  "slug": "/about-us",
  "state": 64,
  "trigger": {
    "id": "a7bce3da-9727-4ca8-b95b-57f731445c3f",
    "type": "release"
  },
  "type": "page"
}

entry.published

Triggers when an entry has been published.

Example
JSON
{
  "api_url": "https://uniform.app/api/v1/entries?projectId=644ede73-d6aa-4159-bf98-14ad7fb4cb66&entryIDs=e5c95c60-314b-4700-9035-6f9c2a4ff800&state=64",
  "edge_url": "https://uniform.global/api/v1/entries?projectId=644ede73-d6aa-4159-bf98-14ad7fb4cb66&entryIDs=e5c95c60-314b-4700-9035-6f9c2a4ff800&state=64",
  "edit_url": "https://uniform.app/projects/644ede73-d6aa-4159-bf98-14ad7fb4cb66/dashboards/canvas/entries/e5c95c60-314b-4700-9035-6f9c2a4ff800",
  "id": "e5c95c60-314b-4700-9035-6f9c2a4ff800",
  "name": "About Us",
  "project": {
    "id": "644ede73-d6aa-4159-bf98-14ad7fb4cb66",
    "url": "https://uniform.app/projects/644ede73-d6aa-4159-bf98-14ad7fb4cb66"
  },
  "slug": "/about-us",
  "state": 64,
  "trigger": {
    "id": "a7bce3da-9727-4ca8-b95b-57f731445c3f",
    "type": "release"
  },
  "type": "page"
}

entry.release.changed

Triggers when an entry has been changed that is attached to a pre-launch release.

Example
JSON
{
  "api_url": "https://uniform.app/api/v1/entries?projectId=644ede73-d6aa-4159-bf98-14ad7fb4cb66&entryIDs=e5c95c60-314b-4700-9035-6f9c2a4ff800&state=64&releaseId=48293345-f2d0-1125-afda-7c661abad432",
  "edge_url": "https://uniform.global/api/v1/entries?projectId=644ede73-d6aa-4159-bf98-14ad7fb4cb66&entryIDs=e5c95c60-314b-4700-9035-6f9c2a4ff800&state=64&releaseId=48293345-f2d0-1125-afda-7c661abad432",
  "edit_url": "https://uniform.app/projects/644ede73-d6aa-4159-bf98-14ad7fb4cb66/dashboards/canvas/entries/e5c95c60-314b-4700-9035-6f9c2a4ff800?release=48293345-f2d0-1125-afda-7c661abad432",
  "id": "e5c95c60-314b-4700-9035-6f9c2a4ff800",
  "name": "About Us",
  "project": {
    "id": "644ede73-d6aa-4159-bf98-14ad7fb4cb66",
    "url": "https://uniform.app/projects/644ede73-d6aa-4159-bf98-14ad7fb4cb66"
  },
  "release": {
    "id": "48293345-f2d0-1125-afda-7c661abad432",
    "url": "https://uniform.app/projects/644ede73-d6aa-4159-bf98-14ad7fb4cb66/releases/48293345-f2d0-1125-afda-7c661abad432"
  },
  "slug": "/about-us",
  "state": 64,
  "type": "page"
}

entry.release.deleted

Triggers when an entry has been deleted that is attached to a pre-launch release.

Example
JSON
{
  "id": "e5c95c60-314b-4700-9035-6f9c2a4ff800",
  "name": "About Us",
  "project": {
    "id": "644ede73-d6aa-4159-bf98-14ad7fb4cb66",
    "url": "https://uniform.app/projects/644ede73-d6aa-4159-bf98-14ad7fb4cb66"
  },
  "release": {
    "id": "48293345-f2d0-1125-afda-7c661abad432",
    "url": "https://uniform.app/projects/644ede73-d6aa-4159-bf98-14ad7fb4cb66/releases/48293345-f2d0-1125-afda-7c661abad432"
  },
  "slug": "/about-us",
  "state": 64,
  "type": "page"
}

entry.release.published

Triggers when an entry has been published that is attached to a pre-launch release.

Example
JSON
{
  "api_url": "https://uniform.app/api/v1/entries?projectId=644ede73-d6aa-4159-bf98-14ad7fb4cb66&entryIDs=e5c95c60-314b-4700-9035-6f9c2a4ff800&state=64&releaseId=48293345-f2d0-1125-afda-7c661abad432",
  "edge_url": "https://uniform.global/api/v1/entries?projectId=644ede73-d6aa-4159-bf98-14ad7fb4cb66&entryIDs=e5c95c60-314b-4700-9035-6f9c2a4ff800&state=64&releaseId=48293345-f2d0-1125-afda-7c661abad432",
  "edit_url": "https://uniform.app/projects/644ede73-d6aa-4159-bf98-14ad7fb4cb66/dashboards/canvas/entries/e5c95c60-314b-4700-9035-6f9c2a4ff800?release=48293345-f2d0-1125-afda-7c661abad432",
  "id": "e5c95c60-314b-4700-9035-6f9c2a4ff800",
  "name": "About Us",
  "project": {
    "id": "644ede73-d6aa-4159-bf98-14ad7fb4cb66",
    "url": "https://uniform.app/projects/644ede73-d6aa-4159-bf98-14ad7fb4cb66"
  },
  "release": {
    "id": "48293345-f2d0-1125-afda-7c661abad432",
    "url": "https://uniform.app/projects/644ede73-d6aa-4159-bf98-14ad7fb4cb66/releases/48293345-f2d0-1125-afda-7c661abad432"
  },
  "slug": "/about-us",
  "state": 64,
  "type": "page"
}

manifest.published

Triggers when a manifest has been published.

Example
JSON
{
  "site": {
    "id": "644ede73-d6aa-4159-bf98-14ad7fb4cb66",
    "name": "My Site"
  },
  "timestamp": 1667425322407
}

projectmap.delete

Triggers when a project map is deleted.

Example
JSON
{
  "base_url": "https://stuff.org",
  "id": "644ede73-d6aa-4159-bf98-14ad7fb4cb66",
  "project_id": "bf978bb4-693b-4e75-9a57-8c89d27f4496"
}

projectmap.node.delete

Triggers when a project map node is deleted.

Example
JSON
{
  "composition_id": "644ede73-d6aa-4159-bf98-14ad7fb4cb66",
  "id": "644ede73-d6aa-4159-bf98-14ad7fb4cb66",
  "path": "/product-detail",
  "project_id": "bf978bb4-693b-4e75-9a57-8c89d27f4496",
  "project_map_id": "c57ba7ac-4b5a-42f2-980f-afc75fe9d234"
}

projectmap.node.insert

Triggers when a project map node is inserted.

Example
JSON
{
  "composition_id": "644ede73-d6aa-4159-bf98-14ad7fb4cb66",
  "id": "644ede73-d6aa-4159-bf98-14ad7fb4cb66",
  "path": "/product-detail",
  "project_id": "bf978bb4-693b-4e75-9a57-8c89d27f4496",
  "project_map_id": "c57ba7ac-4b5a-42f2-980f-afc75fe9d234"
}

projectmap.node.update

Triggers when a project map node is updated.

Example
JSON
{
  "composition_id": "644ede73-d6aa-4159-bf98-14ad7fb4cb66",
  "id": "644ede73-d6aa-4159-bf98-14ad7fb4cb66",
  "path": "/product-detail",
  "previous_path": "/promo/product-detail",
  "project_id": "bf978bb4-693b-4e75-9a57-8c89d27f4496",
  "project_map_id": "c57ba7ac-4b5a-42f2-980f-afc75fe9d234"
}

projectmap.update

Triggers when a project map is updated or created.

Example
JSON
{
  "base_url": "https://stuff.org",
  "id": "644ede73-d6aa-4159-bf98-14ad7fb4cb66",
  "project_id": "bf978bb4-693b-4e75-9a57-8c89d27f4496"
}

redirect.delete

Triggers when a redirect is deleted.

Example
JSON
{
  "id": "644ede73-d6aa-4159-bf98-14ad7fb4cb66",
  "project_id": "bf978bb4-693b-4e75-9a57-8c89d27f4496",
  "source_url": "/product-info",
  "target_status_code": 301,
  "target_url": "/product-details"
}

redirect.insert

Triggers when a redirect is inserted.

Example
JSON
{
  "id": "644ede73-d6aa-4159-bf98-14ad7fb4cb66",
  "project_id": "bf978bb4-693b-4e75-9a57-8c89d27f4496",
  "source_url": "/product-info",
  "target_status_code": 301,
  "target_url": "/product-details"
}

redirect.update

Triggers when a redirect is updated.

Example
JSON
{
  "id": "644ede73-d6aa-4159-bf98-14ad7fb4cb66",
  "project_id": "bf978bb4-693b-4e75-9a57-8c89d27f4496",
  "source_url": "/product-info",
  "target_status_code": 301,
  "target_url": "/product-details"
}

release.changed

Triggers when a release definition has been changed.

Example
JSON
{
  "api_url": "https://uniform.app/api/v1/releases?projectId=644ede73-d6aa-4159-bf98-14ad7fb4cb66&releaseIDs=0b9d2118-f2d0-4fe6-9d46-7c661abaf474",
  "autoLaunchSchedule": 12312412312,
  "autoLaunchScheduleTimeZone": "America/New_York",
  "edit_url": "https://uniform.app/projects/644ede73-d6aa-4159-bf98-14ad7fb4cb66/releases/0b9d2118-f2d0-4fe6-9d46-7c661abaf474",
  "id": "0b9d2118-f2d0-4fe6-9d46-7c661abaf474",
  "name": "Sample Release",
  "project": {
    "id": "644ede73-d6aa-4159-bf98-14ad7fb4cb66",
    "url": "https://uniform.app/projects/644ede73-d6aa-4159-bf98-14ad7fb4cb66"
  },
  "state": "open"
}

release.deleted

Triggers when a release, along with any contents, has been deleted.

Example
JSON
{
  "autoLaunchSchedule": 1212412312,
  "autoLaunchScheduleTimeZone": "America/New_York",
  "id": "0b9d2118-f2d0-4fe6-9d46-7c661abaf474",
  "name": "Sample Release",
  "project": {
    "id": "644ede73-d6aa-4159-bf98-14ad7fb4cb66",
    "url": "https://uniform.app/projects/644ede73-d6aa-4159-bf98-14ad7fb4cb66"
  },
  "state": "open"
}

release.launch_started

Triggers when a release starts launching.

Example
JSON
{
  "api_url": "https://uniform.app/api/v1/releases?projectId=644ede73-d6aa-4159-bf98-14ad7fb4cb66&releaseIDs=0b9d2118-f2d0-4fe6-9d46-7c661abaf474",
  "autoLaunchSchedule": 12312412312,
  "autoLaunchScheduleTimeZone": "America/New_York",
  "edit_url": "https://uniform.app/projects/644ede73-d6aa-4159-bf98-14ad7fb4cb66/releases/0b9d2118-f2d0-4fe6-9d46-7c661abaf474",
  "id": "0b9d2118-f2d0-4fe6-9d46-7c661abaf474",
  "name": "Sample Release",
  "project": {
    "id": "644ede73-d6aa-4159-bf98-14ad7fb4cb66",
    "url": "https://uniform.app/projects/644ede73-d6aa-4159-bf98-14ad7fb4cb66"
  },
  "state": "open"
}

release.launched

Triggers when a release completes launching.

Example
JSON
{
  "api_url": "https://uniform.app/api/v1/releases?projectId=644ede73-d6aa-4159-bf98-14ad7fb4cb66&releaseIDs=0b9d2118-f2d0-4fe6-9d46-7c661abaf474",
  "autoLaunchSchedule": 12312412312,
  "autoLaunchScheduleTimeZone": "America/New_York",
  "edit_url": "https://uniform.app/projects/644ede73-d6aa-4159-bf98-14ad7fb4cb66/releases/0b9d2118-f2d0-4fe6-9d46-7c661abaf474",
  "id": "0b9d2118-f2d0-4fe6-9d46-7c661abaf474",
  "name": "Sample Release",
  "project": {
    "id": "644ede73-d6aa-4159-bf98-14ad7fb4cb66",
    "url": "https://uniform.app/projects/644ede73-d6aa-4159-bf98-14ad7fb4cb66"
  },
  "state": "open"
}