Skip to main content

Network Webhooks

Network

When the community (network) setting is updated, network.updated webhook event is called.

When the plan of a community is changed, plan.updated webhook event is called.

Here is how the structure for network webhooks looks like:

Event name: network.updated
{
"networkId": "CAxOmI7I7t",
"context": "NETWORK",
"entityId": "CAxOmI7I7t",
"currentSettings": [],
"type": "SUBSCRIPTION",
"data": {
"time": "2021-12-20T05:24:42.452Z",
"verb": "UPDATED",
"verbAction": "UPDATED",
"actor": {
"id": "olQ88vTqYp",
"roleId": "Kni0OF7HtE",
"roleType": "admin",
"sessionInfo": [
null
]
},
"object": {
"id": "CAxOmI7I7t",
"createdAt": "2021-12-15T21:43:41.848Z",
"updatedAt": "2021-12-20T05:24:42.452Z",
"createdById": "olQ88vTqYp",
"ownerId": "olQ88vTqYp",
"name": "Bettermode Dev Test",
"slug": "bettermode-dev-test",
"description": null,
"domain": "bettermode-dev-test.bettermode.io",
"newDomain": "",
"aliases": [],
"faviconId": null,
"visibility": "public",
"membership": "inviteOnly",
"status": "published",
"statusLocked": false,
"statusReason": [
null
],
"whoCanInviteIds": [
null
],
"logoId": null,
"brandColor": null,
"locale": "en-US",
"incidentEmails": [],
"billingEmail": "[email protected]",
"organizationId": "i7RkgwKXwz",
"navigationSlates": [
null
],
"oldThemes": null,
"activeThemeId": null,
"themes": null,
"topNavigation": null,
"footer": null,
"enabledSocialLogins": [],
"companyName": null,
"entrancePage": null,
"termsOfServiceUrl": null,
"privacyPolicyUrl": null,
"tribeBranding": true,
"subscriptionPlanId": "nFdIdtEoDxhNXJ3qZNwZh",
"memberCapacityDeclared": 5,
"seatCapacityDeclared": 1,
"customMemberCapacity": 0,
"additionalSeatsCapacity": 0,
"hideDefaultAuthenticationForm": false,
"subscriptionPlan": [
null
],
"seatsCapacity": 100,
"memberCapacity": 100,
"memberFields": [
null
],
"newThemes": [],
"activeTheme": null
},
"target": {
"organizationId": "i7RkgwKXwz",
"networkId": "CAxOmI7I7t"
},
"id": "d1549307a9cd08df7dc20f68bda60eb6",
"name": "network.updated",
"noun": "NETWORK",
"shortDescription": "Update Network"
}
}

Apps

When an app is installed or uninstalled, app_installation.created and app_installation.deleted webhook events are called.

Updating app's setting in a community results in app_installation.updated.

The structure for above webhook requests is as followed:

Event name: app_installation.created
{
"networkId": "CAxOmI7I7t",
"context": "NETWORK",
"entityId": "CAxOmI7I7t",
"currentSettings": [],
"type": "SUBSCRIPTION",
"data": {
"time": "2021-12-20T06:30:56.632Z",
"verb": "CREATED",
"verbAction": "ADDED",
"actor": {
"id": "olQ88vTqYp",
"roleId": "Kni0OF7HtE",
"roleType": "admin",
"sessionInfo": [
null
]
},
"object": {
"id": "DDDD7TzDEL9Z",
"networkId": "CAxOmI7I7t",
"appId": "GPZz2dqo8cKi",
"appVersion": "1.0.0",
"installedById": "olQ88vTqYp",
"uninstalledById": null,
"createdAt": "2021-12-20T06:30:56.632Z",
"updatedAt": "2021-12-20T06:30:56.632Z",
"installedAt": "2021-12-20T06:30:56.632Z",
"status": "ENABLED",
"context": "NETWORK",
"entityId": "CAxOmI7I7t",
"permissions": [
null
],
"uninstallationReason": null
},
"target": {
"organizationId": "i7RkgwKXwz",
"networkId": "CAxOmI7I7t",
"appId": "GPZz2dqo8cKi"
},
"id": "462dbccce59f2be5b243180eefb76b4f",
"name": "app_installation.created",
"noun": "APP_INSTALLATION",
"shortDescription": "Install App"
}
}