Get Notification Settings

GET

/api/accounts/:account_id/notification-settings

GET

/api/accounts/:account_id/notification-settings

$ curl https://app.paymentkit.com/api/accounts/account_id/notification-settings \
>      -H "Authorization: Bearer <token>" \
>      -H "Content-Type: application/json"

1 {
2   "invoice": {
3     "on_finalized": true,
4     "on_paid": true
5   },
6   "dunning": {
7     "failed_payment": true
8   },
9   "slack_enabled": true,
10   "slack_webhook_urls": [
11     "https://hooks.slack.com/services/XXXX/YYYY/ZZZZ"
12   ],
13   "slack_payment_succeeded": true,
14   "slack_payment_failed": true,
15   "email_enabled": true,
16   "emails_to_notify": [
17     "finance-team@paymentkit.com"
18   ],
19   "email_payment_succeeded": true,
20   "email_payment_failed": true,
21   "email_config": {
22     "from_email": "billing@paymentkit.com",
23     "reply_to_email": "support@paymentkit.com",
24     "email_signature_name": "Jane Doe",
25     "email_signature_title": "Head of Billing",
26     "cc_recipients": [
27       "accounting@paymentkit.com",
28       "manager@paymentkit.com"
29     ],
30     "bcc_recipients": [
31       "audit@paymentkit.com",
32       "compliance@paymentkit.com"
33     ],
34     "primary_color": "#1A73E8",
35     "background_color": "#F4F6F8",
36     "text_color": "#202124"
37   }
38 }

Get notification settings for an account.

slack_webhook_urls are secrets. The GET response replaces each stored URL with a redacted representation so the UI can render “Slack notifications configured (3 webhooks)” without exposing the raw URLs. PATCH (above) still accepts raw URLs, so the round-trip from the settings page works as long as the UI only re-sends URLs the user explicitly edited.

Get notification settings for an account. ``slack_webhook_urls`` are secrets. The GET response replaces each stored URL with a redacted representation so the UI can render "Slack notifications configured (3 webhooks)" without exposing the raw URLs. PATCH (above) still accepts raw URLs, so the round-trip from the settings page works as long as the UI only re-sends URLs the user explicitly edited.

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Path parameters

account_idstringRequired

Response

Successful Response

invoiceobject or nullOptional

Invoice notification settings

dunningobject or nullOptional

Dunning notification settings

slack_enabledboolean or nullOptionalDefaults to false

Whether Slack notifications are enabled

slack_webhook_urlslist of strings or nullOptional

List of Slack webhook URLs for notifications

slack_payment_succeededboolean or nullOptional

Send Slack notification on payment succeeded

slack_payment_failedboolean or nullOptional

Send Slack notification on payment failed

email_enabledboolean or nullOptionalDefaults to false

Whether email notifications are enabled

emails_to_notifylist of strings or nullOptional

List of email addresses for notifications

email_payment_succeededboolean or nullOptional

Send email notification on payment succeeded

email_payment_failedboolean or nullOptional

Send email notification on payment failed

email_configobject or nullOptional

Email configuration settings for sender, signature, and colors

Errors

422

Unprocessable Entity Error