curl --request PUT \
--url https://{subdomain}.nudj.cx/api/v2/admin/webhooks/configs \
--header 'Content-Type: application/json' \
--header 'x-api-token: <api-key>' \
--data '
{
"webhookConfig": [
{
"events": [
"achievement-completion"
],
"url": "<string>",
"httpMethod": "GET",
"isEnabled": true,
"maxRetries": 2,
"headers": {}
}
]
}
'{
"webhookConfig": [
{
"events": [
"achievement-completion"
],
"url": "<string>",
"httpMethod": "GET",
"isEnabled": true,
"maxRetries": 2,
"headers": {}
}
]
}Update the webhook configuration for the organisation.
curl --request PUT \
--url https://{subdomain}.nudj.cx/api/v2/admin/webhooks/configs \
--header 'Content-Type: application/json' \
--header 'x-api-token: <api-key>' \
--data '
{
"webhookConfig": [
{
"events": [
"achievement-completion"
],
"url": "<string>",
"httpMethod": "GET",
"isEnabled": true,
"maxRetries": 2,
"headers": {}
}
]
}
'{
"webhookConfig": [
{
"events": [
"achievement-completion"
],
"url": "<string>",
"httpMethod": "GET",
"isEnabled": true,
"maxRetries": 2,
"headers": {}
}
]
}Show child attributes
List of events to subscribe to for webhook notifications
achievement-completion, facebook-comment, facebook-follow, facebook-like, image-analysis-object-detection, image-analysis-receipt-detection, instagram-follow, instagram-like, instagram-comment, instagram-share, instagram-post, interaction-engage-with-content, interaction-external-link, interaction-image-upload, interaction-spot-object, platform-comment-on-post, platform-complete-achievement, platform-generative-action, platform-like-post, platform-play-game, platform-validate-event, question-multiple-choice, question-open-ended, question-rate-your-experience, question-secret-access-code, question-select-date, question-select-from-images, question-select-value-in-range, question-select-from-list, question-closed-ended, question-vote, spotify-follow, spotify-listen, spotify-save, tiktok-follow, tiktok-watch, tiktok-post, youtube-like, youtube-comment, youtube-subscribe, action-completion, skip-action, 42-school, api-auth-link, api-token-link, apple, asgardeo, atlassian, auth0, authentik, azure-ad-b2c, azure-ad, azure-devops, battlenet, beyondidentity, box, boxyhq-saml, bungie, click-up, cognito, coinbase, descope, discord, dribbble, dropbox, duende-identity-server6, email, eveonline, facebook, faceit, foursquare, freshbooks, fusionauth, github, gitlab, google, hubspot, identity-server4, instagram, kakao, keycloak, line, linkedin, mailchimp, mailru, mastodon, mattermost, medium, naver, netlify, notion, okta, onelogin, organisation-oidc, osso, osu, passage, patreon, pinterest, pipedrive, reddit, salesforce, slack, spotify, strava, tiktok, todoist, trakt, twitch, twitter, united-effects, vk, wikimedia, wordpress, workos, yandex, youtube, zitadel, zoho, zoom, blog-comment, blog-like, blog-share, blog-view, challenge-started, challenge-completion, challenge-unlock, community-visit, parental-approval-requested, parental-approval-approved, parental-approval-rejected, custom, game-started, game-completed, leaderboard-finish, invite-admin-user, points-credit, points-spend, post-comment, post-like, post-view, reward-redemption, reward-allocation-purchase, reward-giveaway-winner, reward-claim, reward-distribution, manual-distribution, referral-link-used, shop-purchase, share-challenge-details, share-challenge-results, share-community, share-reward, share-post, share-profile, share-anything, streak-extended, profile-picture-added, bio-added, variable-captured, xp-gained, xp-total, xp-leaderboard-topper The webhook endpoint URL
HTTP method to use for webhook requests
GET, POST, PUT Whether this webhook configuration is active
Maximum number of delivery attempts for this webhook
x >= 1Successful response
Show child attributes
List of events to subscribe to for webhook notifications
achievement-completion, facebook-comment, facebook-follow, facebook-like, image-analysis-object-detection, image-analysis-receipt-detection, instagram-follow, instagram-like, instagram-comment, instagram-share, instagram-post, interaction-engage-with-content, interaction-external-link, interaction-image-upload, interaction-spot-object, platform-comment-on-post, platform-complete-achievement, platform-generative-action, platform-like-post, platform-play-game, platform-validate-event, question-multiple-choice, question-open-ended, question-rate-your-experience, question-secret-access-code, question-select-date, question-select-from-images, question-select-value-in-range, question-select-from-list, question-closed-ended, question-vote, spotify-follow, spotify-listen, spotify-save, tiktok-follow, tiktok-watch, tiktok-post, youtube-like, youtube-comment, youtube-subscribe, action-completion, skip-action, 42-school, api-auth-link, api-token-link, apple, asgardeo, atlassian, auth0, authentik, azure-ad-b2c, azure-ad, azure-devops, battlenet, beyondidentity, box, boxyhq-saml, bungie, click-up, cognito, coinbase, descope, discord, dribbble, dropbox, duende-identity-server6, email, eveonline, facebook, faceit, foursquare, freshbooks, fusionauth, github, gitlab, google, hubspot, identity-server4, instagram, kakao, keycloak, line, linkedin, mailchimp, mailru, mastodon, mattermost, medium, naver, netlify, notion, okta, onelogin, organisation-oidc, osso, osu, passage, patreon, pinterest, pipedrive, reddit, salesforce, slack, spotify, strava, tiktok, todoist, trakt, twitch, twitter, united-effects, vk, wikimedia, wordpress, workos, yandex, youtube, zitadel, zoho, zoom, blog-comment, blog-like, blog-share, blog-view, challenge-started, challenge-completion, challenge-unlock, community-visit, parental-approval-requested, parental-approval-approved, parental-approval-rejected, custom, game-started, game-completed, leaderboard-finish, invite-admin-user, points-credit, points-spend, post-comment, post-like, post-view, reward-redemption, reward-allocation-purchase, reward-giveaway-winner, reward-claim, reward-distribution, manual-distribution, referral-link-used, shop-purchase, share-challenge-details, share-challenge-results, share-community, share-reward, share-post, share-profile, share-anything, streak-extended, profile-picture-added, bio-added, variable-captured, xp-gained, xp-total, xp-leaderboard-topper The webhook endpoint URL
HTTP method to use for webhook requests
GET, POST, PUT Whether this webhook configuration is active
Maximum number of delivery attempts for this webhook
x >= 1Was this page helpful?