> ## Documentation Index > Fetch the complete documentation index at: https://docs.nudj.cx/llms.txt > Use this file to discover all available pages before exploring further. # Get webhook configurations > Retrieve the webhook configurations for the organisation. ## OpenAPI ````yaml /openapi/admin.json get /webhooks/configs openapi: 3.1.0 info: title: Nudj Admin API version: 1.0.0 servers: - url: https://{subdomain}.nudj.cx/api/v2/admin description: Organization API Server variables: subdomain: description: Your organization's subdomain (required) default: your-org security: - ApiToken: [] paths: /webhooks/configs: get: tags: - Webhooks summary: Get webhook configurations description: Retrieve the webhook configurations for the organisation. operationId: getWebhookConfigs responses: '200': description: Successful response content: application/json: schema: type: object properties: webhookConfig: type: array items: $ref: '#/components/schemas/WebhookConfig' required: - webhookConfig '400': description: Invalid input data content: application/json: schema: $ref: '#/components/schemas/error.BAD_REQUEST' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/error.NOT_FOUND' '500': description: Internal server error content: application/json: schema: $ref: '#/components/schemas/error.INTERNAL_SERVER_ERROR' components: schemas: WebhookConfig: type: object properties: events: type: array items: type: string enum: - 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 description: List of events to subscribe to for webhook notifications url: type: string format: uri description: The webhook endpoint URL httpMethod: type: string enum: - GET - POST - PUT description: HTTP method to use for webhook requests isEnabled: type: boolean description: Whether this webhook configuration is active maxRetries: type: integer minimum: 1 description: Maximum number of delivery attempts for this webhook headers: type: object additionalProperties: type: string description: Custom headers to include in webhook requests createdAt: type: - string - 'null' format: date-time description: Timestamp when the webhook was created entityFilter: oneOf: - $ref: '#/components/schemas/WebhookEntityFilter' - type: 'null' description: >- Filter webhook events by entity IDs. When not set, webhook fires for all entities. required: - events - url - httpMethod - isEnabled - maxRetries - headers title: Webhook Configuration description: Configuration for webhook endpoints and event subscriptions error.BAD_REQUEST: type: object properties: message: type: string description: The error message example: Invalid input data code: type: string description: The error code example: BAD_REQUEST issues: type: array items: type: object properties: message: type: string required: - message description: An array of issues that were responsible for the error example: [] required: - message - code title: Error description: The error information example: code: BAD_REQUEST message: Invalid input data issues: [] error.NOT_FOUND: type: object properties: message: type: string description: The error message example: Not found code: type: string description: The error code example: NOT_FOUND issues: type: array items: type: object properties: message: type: string required: - message description: An array of issues that were responsible for the error example: [] required: - message - code title: Error description: The error information example: code: NOT_FOUND message: Not found issues: [] error.INTERNAL_SERVER_ERROR: type: object properties: message: type: string description: The error message example: Internal server error code: type: string description: The error code example: INTERNAL_SERVER_ERROR issues: type: array items: type: object properties: message: type: string required: - message description: An array of issues that were responsible for the error example: [] required: - message - code title: Error description: The error information example: code: INTERNAL_SERVER_ERROR message: Internal server error issues: [] WebhookEntityFilter: type: object properties: entityIds: type: array items: type: string pattern: ^[0-9a-fA-F]{24}$ description: >- List of entity IDs to filter webhook events. The filtering behavior is determined by the mode field. mode: type: string enum: - include - exclude description: >- 'include' fires webhook only for entities in the list, 'exclude' fires for all entities except those in the list required: - entityIds - mode title: Webhook Entity Filter description: Filter configuration to control which entities trigger webhook events securitySchemes: ApiToken: type: apiKey in: header name: x-api-token ````