> ## Documentation Index > Fetch the complete documentation index at: https://widgetic.com/llms.txt > Use this file to discover all available pages before exploring further. # Where your notifications go > Returns who gets the emails, which events you want by email and by webhook, the address of your webhook, and whether it has a secret to sign with. The secret itself is never returned: it is shown once, when it is made. `events` lists every kind of event there is, for a settings screen. The caller must be the person who administers the partner (an API key of that account works, with the `partner:read` scope), or a Widgetic administrator. ## OpenAPI ````yaml /openapi/widgetic-api-public.json get /partners/{partnerId}/notifications/settings openapi: 3.0.0 info: title: Widgetic API Gateway version: 1.0.0 description: API documentation for the Widgetic API Gateway license: name: Widgetic Integration License url: https://docs.widgetic.com/resources/license servers: - url: https://api.widgetic.com/v1 description: Production server variables: env: default: production description: Environment apiUrl: default: https://api.widgetic.com description: API URL apiVersion: default: /v1 description: API Version path prefix security: [] tags: [] paths: /partners/{partnerId}/notifications/settings: get: tags: - Partners summary: Where your notifications go description: > Returns who gets the emails, which events you want by email and by webhook, the address of your webhook, and whether it has a secret to sign with. The secret itself is never returned: it is shown once, when it is made. `events` lists every kind of event there is, for a settings screen. The caller must be the person who administers the partner (an API key of that account works, with the `partner:read` scope), or a Widgetic administrator. operationId: getPartnerNotificationSettings parameters: - in: path name: partnerId required: true schema: type: string format: uuid description: The partner whose notification settings to read responses: '200': description: The notification settings content: application/json: schema: $ref: '#/components/schemas/PartnerNotificationSettingsResponse' '401': description: The API key is missing or invalid content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '403': description: The caller does not administer this partner content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '404': description: There is no such partner (reported to administrators only) content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '429': description: Too many requests. Wait a minute. content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' security: - apiKeyAuth: [] components: schemas: PartnerNotificationSettingsResponse: type: object required: - success - data properties: success: type: boolean description: Always `true` on a success. example: true data: $ref: '#/components/schemas/PartnerNotificationSettings' meta: $ref: '#/components/schemas/ResponseMeta' ErrorResponse: type: object required: - success - message - error additionalProperties: true properties: success: type: boolean description: Always `false` on a failure. example: false message: type: string description: The same text as `error.message`, for a caller that reads one line. error: $ref: '#/components/schemas/ErrorDetail' PartnerNotificationSettings: type: object description: >- Where your notifications go. The secret that signs your webhook is never part of it. required: - partnerId - emailRecipients - defaultEmailRecipients - emailEvents - webhookUrl - webhookEvents - webhookSecretSet - webhookSecretRotatedAt - webhookSigningAvailable - events properties: partnerId: type: string format: uuid emailRecipients: type: array description: The addresses the emails go to. Empty means the defaults. items: type: string defaultEmailRecipients: $ref: '#/components/schemas/PartnerNotificationDefaultRecipients' emailEvents: type: array nullable: true description: >- The events you want by email. Null means every event. The events marked `alwaysEmailed` are emailed whatever it says. items: $ref: '#/components/schemas/PartnerNotificationEventType' webhookUrl: type: string nullable: true description: >- Where Widgetic sends a signed call for each event. Null while the webhook is switched off. webhookEvents: type: array nullable: true description: The events sent to your webhook. Null means every event. items: $ref: '#/components/schemas/PartnerNotificationEventType' webhookSecretSet: type: boolean description: Whether a signing secret exists. Calls are made only when it does. webhookSecretRotatedAt: type: string format: date-time nullable: true description: When the current secret was made webhookSigningAvailable: type: boolean description: >- False when this server cannot sign webhooks, in which case a webhook cannot be set up yet events: type: array description: Every event there is, for a settings screen to list items: $ref: '#/components/schemas/PartnerNotificationEvent' example: partnerId: 3fa85f64-5717-4562-b3fc-2c963f66afa6 emailRecipients: [] defaultEmailRecipients: null emailEvents: - Example PartnerNotificationEventType webhookUrl: Example webhookUrl webhookEvents: - Example PartnerNotificationEventType webhookSecretSet: true webhookSecretRotatedAt: '2026-01-15T09:30:00.000Z' webhookSigningAvailable: true events: - Example PartnerNotificationEvent ResponseMeta: type: object description: >- Extra information about the answer: where a page sits in a list, the cursor of the next page, or warnings about a call that succeeded with a caveat. additionalProperties: true properties: page: type: integer description: The page that was read, counting from 1. example: 1 size: type: integer description: How many items one page holds. example: 20 total: type: integer description: How many items the whole list has. example: 135 limit: type: integer description: The same as `size`. example: 20 offset: type: integer description: How many items come before this page. example: 0 hasNextPage: type: boolean example: true hasPreviousPage: type: boolean example: false nextCursor: type: string nullable: true description: >- Pass this as `cursor` to read the next page of a list that is read by cursor. `null` on the last page. warnings: type: array items: type: string description: >- Things the call did not do, though it succeeded (for example a table that could not be created just now). ErrorDetail: type: object required: - code - message - timestamp properties: code: type: string description: Machine-readable error code. example: RESOURCE_NOT_FOUND message: type: string description: Human-readable explanation. example: Composition not found param: type: string description: The field that caused the error, when one did. example: name docUrl: type: string description: Where this error is explained. suggestedAction: type: string description: What to do about it. retryAfter: type: integer description: >- Seconds to wait before trying again (rate limits). The same number is in the `Retry-After` header. example: 60 details: type: object additionalProperties: true description: >- More about the error: the fields that failed, a limit that was reached. correlationId: type: string description: Quote this when you ask support about the call. example: req_123e4567-e89b-12d3-a456-426614174000 timestamp: type: string format: date-time example: '2026-10-15T10:00:00.000Z' PartnerNotificationDefaultRecipients: type: object description: Who gets the emails while you have given no addresses of your own. required: - payments - other properties: payments: type: array description: >- For the invoice events, the billing emails of your billing profile, or your contact email when there are none items: type: string other: type: array description: For every other event, your contact email items: type: string example: payments: [] other: [] PartnerNotificationEventType: type: string description: What happened. The event types you can be told about. enum: - invoice.issued - invoice.due_soon - invoice.overdue - invoice.paid - invoice.failed - credits.low - credits.managed_user_cap_reached - partner.activated - partner.paused - partner.resumed - storage.check_failed - composition.created - composition.updated - widget.published - upload.created - entry.created - workflow.created - workflow.published - workflow.state_changed - workflow.deleted PartnerNotificationEvent: type: object description: One kind of event you can be told about. required: - type - group - label - description - alwaysEmailed - delivery properties: type: $ref: '#/components/schemas/PartnerNotificationEventType' group: type: string enum: - payments - credits - account - storage - content label: type: string description: type: string description: One sentence that says when it happens alwaysEmailed: type: boolean description: >- True for money and standing: you are emailed whatever you chose, and can narrow only what your own system receives. delivery: type: string enum: - all - webhook description: >- `all`: email (when chosen), dashboard inbox and webhook. `webhook`: signed call only — no email and not listed in the dashboard inbox. example: type: null group: Example group label: Example label description: Example description alwaysEmailed: true delivery: Example delivery securitySchemes: apiKeyAuth: type: http scheme: bearer bearerFormat: JWT ```` This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.