Skip to main content

Collection Webhooks

These are the events related to collections:

  • collection.created
  • collection.updated
  • collection.deleted

Create a collection​

Event name: collection.created
{
  "networkId": "ONyPnp8I8o",
  "entityId": "ONyPnp8I8o",
  "type": "SUBSCRIPTION",
  "data": {
    "time": "2023-07-19T15:18:43.387Z",
    "verb": "CREATED",
    "verbAction": "ADDED",
    "actor": {
      "id": "Orqhv62gXX",
      "roleId": "rVghIhIbsp",
      "roleType": "admin",
      "sessionInfo": {
        "ip": "24.201.219.131",
        "country": "CA",
        "locale": "en-US",
        "client": 0,
        "clientVersion": "1.0.0",
        "os": "Mac OS",
        "osVersion": "10.15.7",
        "deviceBrand": "",
        "trackerGlobalSessionId": null,
        "trackerSessionId": null
      }
    },
    "object": {
      "id": "brAA8VaFciUj",
      "networkId": "ONyPnp8I8o",
      "externalId": null,
      "createdById": "Orqhv62gXX",
      "createdAt": "2023-07-19T15:18:43.387Z",
      "updatedAt": "2023-07-19T15:18:43.387Z",
      "customOrderingIndex": 2,
      "status": "created",
      "supId": null,
      "name": "New collection",
      "description": "New collection",
      "slug": "new-collection-e8gsh44r"
    },
    "target": {
      "organizationId": "g1qdNmmQOB",
      "networkId": "ONyPnp8I8o",
      "networkDomain": "community.bettermode.com",
      "groupId": "brAA8VaFciUj",
      "collectionId": "brAA8VaFciUj"
    },
    "id": "ce022007d7a8e77920c9e460b12e95e6",
    "name": "collection.created",
    "noun": "COLLECTION",
    "shortDescription": "Create Space Collection"
  },
  "currentSettings": [],
  "entities": {
    "network": {
      "id": "ONyPnp8I8o",
      "createdAt": "2022-02-17T22:26:32.112Z",
      "updatedAt": "2023-07-19T15:10:41.779Z",
      "name": "Bettermode",
      "slug": "bettermode-community",
      "domain": "community.bettermode.com",
      "visibility": "public",
      "membership": "open",
      "status": "published",
      "brandColor": null,
      "locale": "en-US",
      "tribeBranding": true,
      "subscriptionPlan": {
        "id": "b3MsbGhSBHBmrK1M201m4",
        "networkId": "ONyPnp8I8o",
        "name": "ADVANCED",
        "memberCapacity": 100000,
        "seatCapacity": 1,
        "renewalType": "year",
        "startDate": "2022-04-13T19:11:54.228Z",
        "endDate": null,
        "renewDate": null,
        "trial": false,
        "createdAt": "2022-04-13T19:11:54.231Z",
        "updatedAt": "2022-04-13T19:11:54.231Z",
        "extendable": false
      }
    },
    "actor": {
      "id": "Orqhv62gXX",
      "externalId": null,
      "status": "VERIFIED",
      "username": "admin",
      "email": "[email protected]",
      "emailStatus": "verified",
      "phone": "+15389910983",
      "roleId": "rVghIhIbsp",
      "role": {
        "id": "rVghIhIbsp",
        "createdAt": "2022-02-17T22:26:32.112Z",
        "updatedAt": "2022-02-17T22:26:32.112Z",
        "networkId": "ONyPnp8I8o",
        "name": "Admin",
        "description": null,
        "scopes": [
          "*"
        ],
        "locked": true,
        "type": "admin",
        "visible": true,
        "network": null
      },
      "name": "Bettermode Dev",
      "profilePictureId": null,
      "bannerId": null,
      "tagline": "Bettermode Dev Ambassador",
      "locale": "en-US",
      "createdAt": "2022-02-17T22:26:32.112Z",
      "updatedAt": "2023-06-20T18:27:22.087Z",
      "lastSeenAt": "2023-07-19T15:18:31.417Z",
      "teammate": true,
      "fields": [
        {
          "key": "website",
          "value": "\"https://bettermode.com\""
        },
        {
          "key": "jobTitle",
          "value": "\"Bettermode Dev Engineer\""
        }
      ],
      "settings": {
        "privateMessaging": {
          "privateMessagingEnabled": true
        }
      }
    }
  }
}

Update a collection​

Event name: collection.updated
{
  "networkId": "ONyPnp8I8o",
  "entityId": "ONyPnp8I8o",
  "type": "SUBSCRIPTION",
  "data": {
    "time": "2023-07-19T15:58:17.721Z",
    "verb": "UPDATED",
    "verbAction": "UPDATED",
    "actor": {
      "id": "Orqhv62gXX",
      "roleId": "rVghIhIbsp",
      "roleType": "admin",
      "sessionInfo": {
        "ip": "24.201.219.131",
        "country": "CA",
        "locale": "en-US",
        "client": 0,
        "clientVersion": "1.0.0",
        "os": "Mac OS",
        "osVersion": "10.15.7",
        "deviceBrand": "",
        "trackerGlobalSessionId": null,
        "trackerSessionId": null
      }
    },
    "object": {
      "id": "yQKm5Yr4T7vg",
      "networkId": "ONyPnp8I8o",
      "externalId": null,
      "createdById": "Orqhv62gXX",
      "createdAt": "2023-07-19T15:58:17.721Z",
      "updatedAt": "2023-07-19T15:58:17.721Z",
      "customOrderingIndex": 2,
      "status": "created",
      "supId": null,
      "name": "New col",
      "description": null,
      "slug": "new-col-8d303j6b"
    },
    "target": {
      "organizationId": "g1qdNmmQOB",
      "networkId": "ONyPnp8I8o",
      "networkDomain": "community.bettermode.com",
      "groupId": "yQKm5Yr4T7vg",
      "collectionId": "yQKm5Yr4T7vg"
    },
    "id": "f3a13c50dd9ce975c3f2779d8c1e6b35",
    "name": "collection.updated",
    "noun": "COLLECTION",
    "shortDescription": "Update Space Collection"
  },
  "currentSettings": [],
  "entities": {
    "network": {
      "id": "ONyPnp8I8o",
      "createdAt": "2022-02-17T22:26:32.112Z",
      "updatedAt": "2023-07-19T15:10:41.779Z",
      "name": "Bettermode",
      "slug": "bettermode-community",
      "domain": "community.bettermode.com",
      "visibility": "public",
      "membership": "open",
      "status": "published",
      "brandColor": null,
      "locale": "en-US",
      "tribeBranding": true,
      "subscriptionPlan": {
        "id": "b3MsbGhSBHBmrK1M201m4",
        "networkId": "ONyPnp8I8o",
        "name": "ADVANCED",
        "memberCapacity": 100000,
        "seatCapacity": 1,
        "renewalType": "year",
        "startDate": "2022-04-13T19:11:54.228Z",
        "endDate": null,
        "renewDate": null,
        "trial": false,
        "createdAt": "2022-04-13T19:11:54.231Z",
        "updatedAt": "2022-04-13T19:11:54.231Z",
        "extendable": false
      }
    },
    "actor": {
      "id": "Orqhv62gXX",
      "externalId": null,
      "status": "VERIFIED",
      "username": "admin",
      "email": "[email protected]",
      "emailStatus": "verified",
      "phone": "+15389910983",
      "roleId": "rVghIhIbsp",
      "role": {
        "id": "rVghIhIbsp",
        "createdAt": "2022-02-17T22:26:32.112Z",
        "updatedAt": "2022-02-17T22:26:32.112Z",
        "networkId": "ONyPnp8I8o",
        "name": "Admin",
        "description": null,
        "scopes": [
          "*"
        ],
        "locked": true,
        "type": "admin",
        "visible": true,
        "network": null
      },
      "name": "Bettermode Dev",
      "profilePictureId": null,
      "bannerId": null,
      "tagline": "Bettermode Dev Ambassador",
      "locale": "en-US",
      "createdAt": "2022-02-17T22:26:32.112Z",
      "updatedAt": "2023-06-20T18:27:22.087Z",
      "lastSeenAt": "2023-07-19T15:56:53.086Z",
      "teammate": true,
      "fields": [
        {
          "key": "website",
          "value": "\"https://bettermode.com\""
        },
        {
          "key": "jobTitle",
          "value": "\"Bettermode Dev Engineer\""
        }
      ],
      "settings": {
        "privateMessaging": {
          "privateMessagingEnabled": true
        }
      }
    }
  }
}

Delete a collection​

Event name: collection.deleted
{
  "networkId": "ONyPnp8I8o",
  "entityId": "ONyPnp8I8o",
  "type": "SUBSCRIPTION",
  "data": {
    "time": "2023-07-19T15:19:25.628Z",
    "verb": "DELETED",
    "verbAction": "DELETED",
    "actor": {
      "id": "Orqhv62gXX",
      "roleId": "rVghIhIbsp",
      "roleType": "admin",
      "sessionInfo": {
        "ip": "24.201.219.131",
        "country": "CA",
        "locale": "en-US",
        "client": 0,
        "clientVersion": "1.0.0",
        "os": "Mac OS",
        "osVersion": "10.15.7",
        "deviceBrand": "",
        "trackerGlobalSessionId": null,
        "trackerSessionId": null
      }
    },
    "object": {
      "id": "brAA8VaFciUj",
      "networkId": "ONyPnp8I8o",
      "externalId": null,
      "createdById": "Orqhv62gXX",
      "createdAt": "2023-07-19T15:18:43.387Z",
      "updatedAt": "2023-07-19T15:19:25.628Z",
      "customOrderingIndex": 0,
      "status": "deleted",
      "supId": null,
      "name": "New collection",
      "description": "New collection",
      "slug": "new-collection-e8gsh44r"
    },
    "target": {
      "organizationId": "g1qdNmmQOB",
      "networkId": "ONyPnp8I8o",
      "networkDomain": "community.bettermode.com",
      "groupId": "brAA8VaFciUj",
      "collectionId": "brAA8VaFciUj"
    },
    "id": "77890e223afcbd97c074063b619cb14a",
    "name": "collection.deleted",
    "noun": "COLLECTION",
    "shortDescription": "Delete Space Collection"
  },
  "currentSettings": [],
  "entities": {
    "network": {
      "id": "ONyPnp8I8o",
      "createdAt": "2022-02-17T22:26:32.112Z",
      "updatedAt": "2023-07-19T15:10:41.779Z",
      "name": "Bettermode",
      "slug": "bettermode-community",
      "domain": "community.bettermode.com",
      "visibility": "public",
      "membership": "open",
      "status": "published",
      "brandColor": null,
      "locale": "en-US",
      "tribeBranding": true,
      "subscriptionPlan": {
        "id": "b3MsbGhSBHBmrK1M201m4",
        "networkId": "ONyPnp8I8o",
        "name": "ADVANCED",
        "memberCapacity": 100000,
        "seatCapacity": 1,
        "renewalType": "year",
        "startDate": "2022-04-13T19:11:54.228Z",
        "endDate": null,
        "renewDate": null,
        "trial": false,
        "createdAt": "2022-04-13T19:11:54.231Z",
        "updatedAt": "2022-04-13T19:11:54.231Z",
        "extendable": false
      }
    },
    "actor": {
      "id": "Orqhv62gXX",
      "externalId": null,
      "status": "VERIFIED",
      "username": "admin",
      "email": "[email protected]",
      "emailStatus": "verified",
      "phone": "+15389910983",
      "roleId": "rVghIhIbsp",
      "role": {
        "id": "rVghIhIbsp",
        "createdAt": "2022-02-17T22:26:32.112Z",
        "updatedAt": "2022-02-17T22:26:32.112Z",
        "networkId": "ONyPnp8I8o",
        "name": "Admin",
        "description": null,
        "scopes": [
          "*"
        ],
        "locked": true,
        "type": "admin",
        "visible": true,
        "network": null
      },
      "name": "Bettermode Dev",
      "profilePictureId": null,
      "bannerId": null,
      "tagline": "Bettermode Dev Ambassador",
      "locale": "en-US",
      "createdAt": "2022-02-17T22:26:32.112Z",
      "updatedAt": "2023-06-20T18:27:22.087Z",
      "lastSeenAt": "2023-07-19T15:18:31.417Z",
      "teammate": true,
      "fields": [
        {
          "key": "website",
          "value": "\"https://bettermode.com\""
        },
        {
          "key": "jobTitle",
          "value": "\"Bettermode Dev Engineer\""
        }
      ],
      "settings": {
        "privateMessaging": {
          "privateMessagingEnabled": true
        }
      }
    }
  }
}