--- title: "Create subscription" method: POST path: "/subscriptions/1/subscription/{channel}" tags: ["platform", "subscriptions-api", "subscription"] --- # Create subscription `POST /subscriptions/1/subscription/{channel}` ## Request - Base URL: `https://api.infobip.com` (the document declares no server; this is the origin it was published from) - URL: `https://api.infobip.com/subscriptions/1/subscription/{channel}` - Auth: one of: - OAuth 2 - Client credentials - Token URL: `https://api.infobip.com/auth/1/oauth2/token` - API key in header `Authorization` - API key in header `Authorization` - HTTP basic This method will create a new subscription. You can provide an ID of an existing profile, or submit a full definition of a profile and security settings if you want to create new ones. ## Path parameters - `channel` 'AGENT_OS' | 'APPLE_MESSAGES_FOR_BUSINESS' | 'BLOCKLIST' | 'CUSTOMER_ENGAGEMENT' | 'EMAIL' | 'FACEBOOK' | 'KAKAO_ALIM' | 'KAKAO_BRAND_MESSAGE' | 'LINE' | 'MMS' | 'MOBILE_IDENTITY' | 'MOBILE_PUSH' | 'NUMBER_LOOKUP' | 'OPEN_CHANNEL' | 'RCS' | 'REGISTRATION' | 'SMS' | 'VIBER' | 'VOICE_VIDEO' | 'WEB_PUSH' | 'WHATSAPP' | 'ZALO', required ## Request body - union - 6e71a232d29cf86cbe8cd24bd719c2050de4613347854f985c920dd3d0d3e33fAgentOsSubscriptionRequest: Subscription group. - `subscriptionId` string, required: Subscription ID. Used as part of a URL path and must not include any characters that require URL encoding. You cannot change the ID once a subscription is created. - `name` string: A human-readable description for your subscription, can be changed at a later point. - `subscriptionGroupId` string: Subscription group identifier. Subscriptions with different group IDs for the same event will each receive the event independently, enabling multi-webhook delivery. - `events` 6e71a232d29cf86cbe8cd24bd719c2050de4613347854f985c920dd3d0d3e33fSimpleAgentOsEvents[], required: List of events available for a subscription. Note that a set of events available for each channel is different; subscription to events that are unavailable for a certain channel will be ignored. For more details, see the [availability table](https://www.infobip.com/docs/cpaas-x/subscriptions-management/event-subscriptions). If configuring inbound Subscription, check [inbound message configuration docs](https://www.infobip.com/docs/cpaas-x/subscriptions-management/inbound-message-configuration). - `criteria` 6e71a232d29cf86cbe8cd24bd719c2050de4613347854f985c920dd3d0d3e33fApplicationEntityPair[]: Application and Entity pair to match. You can set the rule to match only Application or only Entity if necessary, omitting the other item. - `applicationId` string: CPaaS X property identifying an application, an use case or an environment on your system. Should only be set if you are using CPaaS X Applications with your traffic. - `entityId` string: CPaaS X property identifying an unique actor on your system. Should only be set if you are using CPaaS X Applications with your traffic. - `callsConfigurationId` string: CPaaS X calls configuration identifier. Should only be set if you are using CPaaS X Applications with your traffic. - `resources` string[]: List of resources to match. At the moment, this could only be a sender name (whether numeric or alpha) used on message submit. - `users` string[]: List of users to match. You can provide usernames from your account. - `keywords` string[]: List of keywords to match. Route inbound messages by their first word. A customer texting STOP or ORDER to your number triggers only the subscriptions matching that keyword. - `profile` 6e71a232d29cf86cbe8cd24bd719c2050de4613347854f985c920dd3d0d3e33fProfileRequest, required: Notification profile object holding the settings for your webhook URL and a reference to security settings. You can provide full definition of a notification profile and security settings if you want to create new items, or provide an ID of an existing profile to reuse it. If you want to reuse an existing profile, do not provide any other notification profile and security settings properties. - `profileId` string, required: ID of a notification profile. This identifier will be used as part of a URL path and must not include any characters that require URL encoding. You cannot change the ID once an item is created. - `webhook` 6e71a232d29cf86cbe8cd24bd719c2050de4613347854f985c920dd3d0d3e33fWebhook: Webhook configuration. - `contentType` string - `notifyUrl` string, required: Your webhook URL, where the notifications will be sent to. - `security` 6e71a232d29cf86cbe8cd24bd719c2050de4613347854f985c920dd3d0d3e33fSecurityRequest: Security settings object holding the authentication settings necessary to access your webhook. Should only be provided if you are creating a new profile and settings; otherwise it will be ignored. - `authId` string, required: Unique security setting ID. Used as part of a URL path and must not include any characters that require URL encoding. You cannot change the ID once an item is created. - `type` 'BASIC' | 'HMAC' | 'OAUTH': Credentials type. - `credentials` union: Webhook security credentials. - object: Basic credentials. - `username` string, required: Username. - `password` string, required: Password. - object: HMAC credentials. - `secretKey` string, required: Secret key. - `algorithm` 'HMAC_MD5' | 'HMAC_SHA_1' | 'HMAC_SHA_224' | 'HMAC_SHA_256' | 'HMAC_SHA_384' | 'HMAC_SHA_512', required: HMAC algorithm. - object: OAuth credentials. - `tokenUrl` string, required: Token URL. - `clientId` string: Client ID. - `clientSecret` string: Client secret. - `grantType` string, required: Grant type. - `scope` string: Scope. - `username` string: Username. - `password` string: Password. - `resource` string: Resource. - `refreshToken` string: Refresh token. - `headers` object: Set of key:value pairs that will be sent in a HTTP request as headers. - `clientCertificateId` string: Client certificate ID. - `maxBucketSize` integer: Specifies a maximum number of messages to be sent within a single request. - `windowSize` integer: A maximum number of concurrent connections (active requests) per client. - `connectTimeout` integer: Time in milliseconds sender system waits for connection acknowledgement until the connection is closed. - `readTimeout` integer: A maximum period of inactivity in milliseconds between two consecutive data packets. - `enabledSSLProtocols` string[]: Specifies which security protocols should be used to send a HTTP request. Multiple options can be used. - `headers` object: Set of key:value pairs that will be sent in a HTTP request as headers.Note: 'Authorization' header (if configured here for any reason) can be overridden with one from security config. - `responseRegex` string: Response regex. - `responseBodyRegex` string: Response body regex. - `rateLimit` integer: Limits the number of requests per second. - 6e71a232d29cf86cbe8cd24bd719c2050de4613347854f985c920dd3d0d3e33fAppleMessagesForBusinessSubscriptionRequest: Subscription group. - `subscriptionId` string, required: Subscription ID. Used as part of a URL path and must not include any characters that require URL encoding. You cannot change the ID once a subscription is created. - `name` string: A human-readable description for your subscription, can be changed at a later point. - `subscriptionGroupId` string: Subscription group identifier. Subscriptions with different group IDs for the same event will each receive the event independently, enabling multi-webhook delivery. - `events` union[], required: List of events available for a subscription. Note that a set of events available for each channel is different; subscription to events that are unavailable for a certain channel will be ignored. For more details, see the [availability table](https://www.infobip.com/docs/cpaas-x/subscriptions-management/event-subscriptions). If configuring inbound Subscription, check [inbound message configuration docs](https://www.infobip.com/docs/cpaas-x/subscriptions-management/inbound-message-configuration). - union - 'DELIVERY' | 'INBOUND_MESSAGE' | 'TYPING_INDICATOR' - 6e71a232d29cf86cbe8cd24bd719c2050de4613347854f985c920dd3d0d3e33fFormatAwareAppleMessagesForBusinessEvents - `event` 'DELIVERY' | 'INBOUND_MESSAGE' | 'TYPING_INDICATOR', required - `format` string, required: Format which you want to assign to the event. For more information about available formats and their payload, check our [Event Formats](https://www.infobip.com/docs/cpaas-x/subscriptions-management/event-formats) page. - `criteria` 6e71a232d29cf86cbe8cd24bd719c2050de4613347854f985c920dd3d0d3e33fApplicationEntityPair[]: Application and Entity pair to match. You can set the rule to match only Application or only Entity if necessary, omitting the other item. - `applicationId` string: CPaaS X property identifying an application, an use case or an environment on your system. Should only be set if you are using CPaaS X Applications with your traffic. - `entityId` string: CPaaS X property identifying an unique actor on your system. Should only be set if you are using CPaaS X Applications with your traffic. - `callsConfigurationId` string: CPaaS X calls configuration identifier. Should only be set if you are using CPaaS X Applications with your traffic. - `resources` string[]: List of resources to match. At the moment, this could only be a sender name (whether numeric or alpha) used on message submit. - `users` string[]: List of users to match. You can provide usernames from your account. - `keywords` string[]: List of keywords to match. Route inbound messages by their first word. A customer texting STOP or ORDER to your number triggers only the subscriptions matching that keyword. - `profile` 6e71a232d29cf86cbe8cd24bd719c2050de4613347854f985c920dd3d0d3e33fProfileRequest, required: Notification profile object holding the settings for your webhook URL and a reference to security settings. You can provide full definition of a notification profile and security settings if you want to create new items, or provide an ID of an existing profile to reuse it. If you want to reuse an existing profile, do not provide any other notification profile and security settings properties. - `profileId` string, required: ID of a notification profile. This identifier will be used as part of a URL path and must not include any characters that require URL encoding. You cannot change the ID once an item is created. - `webhook` 6e71a232d29cf86cbe8cd24bd719c2050de4613347854f985c920dd3d0d3e33fWebhook: Webhook configuration. - `contentType` string - `notifyUrl` string, required: Your webhook URL, where the notifications will be sent to. - `security` 6e71a232d29cf86cbe8cd24bd719c2050de4613347854f985c920dd3d0d3e33fSecurityRequest: Security settings object holding the authentication settings necessary to access your webhook. Should only be provided if you are creating a new profile and settings; otherwise it will be ignored. - `authId` string, required: Unique security setting ID. Used as part of a URL path and must not include any characters that require URL encoding. You cannot change the ID once an item is created. - `type` 'BASIC' | 'HMAC' | 'OAUTH': Credentials type. - `credentials` union: Webhook security credentials. - object: Basic credentials. - `username` string, required: Username. - `password` string, required: Password. - object: HMAC credentials. - `secretKey` string, required: Secret key. - `algorithm` 'HMAC_MD5' | 'HMAC_SHA_1' | 'HMAC_SHA_224' | 'HMAC_SHA_256' | 'HMAC_SHA_384' | 'HMAC_SHA_512', required: HMAC algorithm. - object: OAuth credentials. - `tokenUrl` string, required: Token URL. - `clientId` string: Client ID. - `clientSecret` string: Client secret. - `grantType` string, required: Grant type. - `scope` string: Scope. - `username` string: Username. - `password` string: Password. - `resource` string: Resource. - `refreshToken` string: Refresh token. - `headers` object: Set of key:value pairs that will be sent in a HTTP request as headers. - `clientCertificateId` string: Client certificate ID. - `maxBucketSize` integer: Specifies a maximum number of messages to be sent within a single request. - `windowSize` integer: A maximum number of concurrent connections (active requests) per client. - `connectTimeout` integer: Time in milliseconds sender system waits for connection acknowledgement until the connection is closed. - `readTimeout` integer: A maximum period of inactivity in milliseconds between two consecutive data packets. - `enabledSSLProtocols` string[]: Specifies which security protocols should be used to send a HTTP request. Multiple options can be used. - `headers` object: Set of key:value pairs that will be sent in a HTTP request as headers.Note: 'Authorization' header (if configured here for any reason) can be overridden with one from security config. - `responseRegex` string: Response regex. - `responseBodyRegex` string: Response body regex. - `rateLimit` integer: Limits the number of requests per second. - 6e71a232d29cf86cbe8cd24bd719c2050de4613347854f985c920dd3d0d3e33fBlocklistSubscriptionRequest: Subscription group. - `subscriptionId` string, required: Subscription ID. Used as part of a URL path and must not include any characters that require URL encoding. You cannot change the ID once a subscription is created. - `name` string: A human-readable description for your subscription, can be changed at a later point. - `subscriptionGroupId` string: Subscription group identifier. Subscriptions with different group IDs for the same event will each receive the event independently, enabling multi-webhook delivery. - `events` union[], required: List of events available for a subscription. Note that a set of events available for each channel is different; subscription to events that are unavailable for a certain channel will be ignored. For more details, see the [availability table](https://www.infobip.com/docs/cpaas-x/subscriptions-management/event-subscriptions). If configuring inbound Subscription, check [inbound message configuration docs](https://www.infobip.com/docs/cpaas-x/subscriptions-management/inbound-message-configuration). - union - 'BLOCK' | 'UNBLOCK' - 6e71a232d29cf86cbe8cd24bd719c2050de4613347854f985c920dd3d0d3e33fFormatAwareBlocklistEvents - `event` 'BLOCK' | 'UNBLOCK', required - `format` string, required: Format which you want to assign to the event. For more information about available formats and their payload, check our [Event Formats](https://www.infobip.com/docs/cpaas-x/subscriptions-management/event-formats) page. - `criteria` 6e71a232d29cf86cbe8cd24bd719c2050de4613347854f985c920dd3d0d3e33fApplicationEntityPair[]: Application and Entity pair to match. You can set the rule to match only Application or only Entity if necessary, omitting the other item. - `applicationId` string: CPaaS X property identifying an application, an use case or an environment on your system. Should only be set if you are using CPaaS X Applications with your traffic. - `entityId` string: CPaaS X property identifying an unique actor on your system. Should only be set if you are using CPaaS X Applications with your traffic. - `callsConfigurationId` string: CPaaS X calls configuration identifier. Should only be set if you are using CPaaS X Applications with your traffic. - `resources` string[]: List of resources to match. At the moment, this could only be a sender name (whether numeric or alpha) used on message submit. - `users` string[]: List of users to match. You can provide usernames from your account. - `keywords` string[]: List of keywords to match. Route inbound messages by their first word. A customer texting STOP or ORDER to your number triggers only the subscriptions matching that keyword. - `profile` 6e71a232d29cf86cbe8cd24bd719c2050de4613347854f985c920dd3d0d3e33fProfileRequest, required: Notification profile object holding the settings for your webhook URL and a reference to security settings. You can provide full definition of a notification profile and security settings if you want to create new items, or provide an ID of an existing profile to reuse it. If you want to reuse an existing profile, do not provide any other notification profile and security settings properties. - `profileId` string, required: ID of a notification profile. This identifier will be used as part of a URL path and must not include any characters that require URL encoding. You cannot change the ID once an item is created. - `webhook` 6e71a232d29cf86cbe8cd24bd719c2050de4613347854f985c920dd3d0d3e33fWebhook: Webhook configuration. - `contentType` string - `notifyUrl` string, required: Your webhook URL, where the notifications will be sent to. - `security` 6e71a232d29cf86cbe8cd24bd719c2050de4613347854f985c920dd3d0d3e33fSecurityRequest: Security settings object holding the authentication settings necessary to access your webhook. Should only be provided if you are creating a new profile and settings; otherwise it will be ignored. - `authId` string, required: Unique security setting ID. Used as part of a URL path and must not include any characters that require URL encoding. You cannot change the ID once an item is created. - `type` 'BASIC' | 'HMAC' | 'OAUTH': Credentials type. - `credentials` union: Webhook security credentials. - object: Basic credentials. - `username` string, required: Username. - `password` string, required: Password. - object: HMAC credentials. - `secretKey` string, required: Secret key. - `algorithm` 'HMAC_MD5' | 'HMAC_SHA_1' | 'HMAC_SHA_224' | 'HMAC_SHA_256' | 'HMAC_SHA_384' | 'HMAC_SHA_512', required: HMAC algorithm. - object: OAuth credentials. - `tokenUrl` string, required: Token URL. - `clientId` string: Client ID. - `clientSecret` string: Client secret. - `grantType` string, required: Grant type. - `scope` string: Scope. - `username` string: Username. - `password` string: Password. - `resource` string: Resource. - `refreshToken` string: Refresh token. - `headers` object: Set of key:value pairs that will be sent in a HTTP request as headers. - `clientCertificateId` string: Client certificate ID. - `maxBucketSize` integer: Specifies a maximum number of messages to be sent within a single request. - `windowSize` integer: A maximum number of concurrent connections (active requests) per client. - `connectTimeout` integer: Time in milliseconds sender system waits for connection acknowledgement until the connection is closed. - `readTimeout` integer: A maximum period of inactivity in milliseconds between two consecutive data packets. - `enabledSSLProtocols` string[]: Specifies which security protocols should be used to send a HTTP request. Multiple options can be used. - `headers` object: Set of key:value pairs that will be sent in a HTTP request as headers.Note: 'Authorization' header (if configured here for any reason) can be overridden with one from security config. - `responseRegex` string: Response regex. - `responseBodyRegex` string: Response body regex. - `rateLimit` integer: Limits the number of requests per second. - 6e71a232d29cf86cbe8cd24bd719c2050de4613347854f985c920dd3d0d3e33fCustomerEngagementSubscriptionRequest: Subscription group. - `subscriptionId` string, required: Subscription ID. Used as part of a URL path and must not include any characters that require URL encoding. You cannot change the ID once a subscription is created. - `name` string: A human-readable description for your subscription, can be changed at a later point. - `subscriptionGroupId` string: Subscription group identifier. Subscriptions with different group IDs for the same event will each receive the event independently, enabling multi-webhook delivery. - `events` 6e71a232d29cf86cbe8cd24bd719c2050de4613347854f985c920dd3d0d3e33fSimpleCustomerEngagementEvents[], required: List of events available for a subscription. Note that a set of events available for each channel is different; subscription to events that are unavailable for a certain channel will be ignored. For more details, see the [availability table](https://www.infobip.com/docs/cpaas-x/subscriptions-management/event-subscriptions). If configuring inbound Subscription, check [inbound message configuration docs](https://www.infobip.com/docs/cpaas-x/subscriptions-management/inbound-message-configuration). - `criteria` 6e71a232d29cf86cbe8cd24bd719c2050de4613347854f985c920dd3d0d3e33fApplicationEntityPair[]: Application and Entity pair to match. You can set the rule to match only Application or only Entity if necessary, omitting the other item. - `applicationId` string: CPaaS X property identifying an application, an use case or an environment on your system. Should only be set if you are using CPaaS X Applications with your traffic. - `entityId` string: CPaaS X property identifying an unique actor on your system. Should only be set if you are using CPaaS X Applications with your traffic. - `callsConfigurationId` string: CPaaS X calls configuration identifier. Should only be set if you are using CPaaS X Applications with your traffic. - `resources` string[]: List of resources to match. At the moment, this could only be a sender name (whether numeric or alpha) used on message submit. - `users` string[]: List of users to match. You can provide usernames from your account. - `keywords` string[]: List of keywords to match. Route inbound messages by their first word. A customer texting STOP or ORDER to your number triggers only the subscriptions matching that keyword. - `profile` 6e71a232d29cf86cbe8cd24bd719c2050de4613347854f985c920dd3d0d3e33fProfileRequest, required: Notification profile object holding the settings for your webhook URL and a reference to security settings. You can provide full definition of a notification profile and security settings if you want to create new items, or provide an ID of an existing profile to reuse it. If you want to reuse an existing profile, do not provide any other notification profile and security settings properties. - `profileId` string, required: ID of a notification profile. This identifier will be used as part of a URL path and must not include any characters that require URL encoding. You cannot change the ID once an item is created. - `webhook` 6e71a232d29cf86cbe8cd24bd719c2050de4613347854f985c920dd3d0d3e33fWebhook: Webhook configuration. - `contentType` string - `notifyUrl` string, required: Your webhook URL, where the notifications will be sent to. - `security` 6e71a232d29cf86cbe8cd24bd719c2050de4613347854f985c920dd3d0d3e33fSecurityRequest: Security settings object holding the authentication settings necessary to access your webhook. Should only be provided if you are creating a new profile and settings; otherwise it will be ignored. - `authId` string, required: Unique security setting ID. Used as part of a URL path and must not include any characters that require URL encoding. You cannot change the ID once an item is created. - `type` 'BASIC' | 'HMAC' | 'OAUTH': Credentials type. - `credentials` union: Webhook security credentials. - object: Basic credentials. - `username` string, required: Username. - `password` string, required: Password. - object: HMAC credentials. - `secretKey` string, required: Secret key. - `algorithm` 'HMAC_MD5' | 'HMAC_SHA_1' | 'HMAC_SHA_224' | 'HMAC_SHA_256' | 'HMAC_SHA_384' | 'HMAC_SHA_512', required: HMAC algorithm. - object: OAuth credentials. - `tokenUrl` string, required: Token URL. - `clientId` string: Client ID. - `clientSecret` string: Client secret. - `grantType` string, required: Grant type. - `scope` string: Scope. - `username` string: Username. - `password` string: Password. - `resource` string: Resource. - `refreshToken` string: Refresh token. - `headers` object: Set of key:value pairs that will be sent in a HTTP request as headers. - `clientCertificateId` string: Client certificate ID. - `maxBucketSize` integer: Specifies a maximum number of messages to be sent within a single request. - `windowSize` integer: A maximum number of concurrent connections (active requests) per client. - `connectTimeout` integer: Time in milliseconds sender system waits for connection acknowledgement until the connection is closed. - `readTimeout` integer: A maximum period of inactivity in milliseconds between two consecutive data packets. - `enabledSSLProtocols` string[]: Specifies which security protocols should be used to send a HTTP request. Multiple options can be used. - `headers` object: Set of key:value pairs that will be sent in a HTTP request as headers.Note: 'Authorization' header (if configured here for any reason) can be overridden with one from security config. - `responseRegex` string: Response regex. - `responseBodyRegex` string: Response body regex. - `rateLimit` integer: Limits the number of requests per second. - 6e71a232d29cf86cbe8cd24bd719c2050de4613347854f985c920dd3d0d3e33fEmailSubscriptionRequest: Subscription group. - `subscriptionId` string, required: Subscription ID. Used as part of a URL path and must not include any characters that require URL encoding. You cannot change the ID once a subscription is created. - `name` string: A human-readable description for your subscription, can be changed at a later point. - `subscriptionGroupId` string: Subscription group identifier. Subscriptions with different group IDs for the same event will each receive the event independently, enabling multi-webhook delivery. - `events` 6e71a232d29cf86cbe8cd24bd719c2050de4613347854f985c920dd3d0d3e33fSimpleEmailEvents[], required: List of events available for a subscription. Note that a set of events available for each channel is different; subscription to events that are unavailable for a certain channel will be ignored. For more details, see the [availability table](https://www.infobip.com/docs/cpaas-x/subscriptions-management/event-subscriptions). If configuring inbound Subscription, check [inbound message configuration docs](https://www.infobip.com/docs/cpaas-x/subscriptions-management/inbound-message-configuration). - `criteria` 6e71a232d29cf86cbe8cd24bd719c2050de4613347854f985c920dd3d0d3e33fApplicationEntityPair[]: Application and Entity pair to match. You can set the rule to match only Application or only Entity if necessary, omitting the other item. - `applicationId` string: CPaaS X property identifying an application, an use case or an environment on your system. Should only be set if you are using CPaaS X Applications with your traffic. - `entityId` string: CPaaS X property identifying an unique actor on your system. Should only be set if you are using CPaaS X Applications with your traffic. - `callsConfigurationId` string: CPaaS X calls configuration identifier. Should only be set if you are using CPaaS X Applications with your traffic. - `resources` string[]: List of resources to match. At the moment, this could only be a sender name (whether numeric or alpha) used on message submit. - `users` string[]: List of users to match. You can provide usernames from your account. - `keywords` string[]: List of keywords to match. Route inbound messages by their first word. A customer texting STOP or ORDER to your number triggers only the subscriptions matching that keyword. - `profile` 6e71a232d29cf86cbe8cd24bd719c2050de4613347854f985c920dd3d0d3e33fProfileRequest, required: Notification profile object holding the settings for your webhook URL and a reference to security settings. You can provide full definition of a notification profile and security settings if you want to create new items, or provide an ID of an existing profile to reuse it. If you want to reuse an existing profile, do not provide any other notification profile and security settings properties. - `profileId` string, required: ID of a notification profile. This identifier will be used as part of a URL path and must not include any characters that require URL encoding. You cannot change the ID once an item is created. - `webhook` 6e71a232d29cf86cbe8cd24bd719c2050de4613347854f985c920dd3d0d3e33fWebhook: Webhook configuration. - `contentType` string - `notifyUrl` string, required: Your webhook URL, where the notifications will be sent to. - `security` 6e71a232d29cf86cbe8cd24bd719c2050de4613347854f985c920dd3d0d3e33fSecurityRequest: Security settings object holding the authentication settings necessary to access your webhook. Should only be provided if you are creating a new profile and settings; otherwise it will be ignored. - `authId` string, required: Unique security setting ID. Used as part of a URL path and must not include any characters that require URL encoding. You cannot change the ID once an item is created. - `type` 'BASIC' | 'HMAC' | 'OAUTH': Credentials type. - `credentials` union: Webhook security credentials. - object: Basic credentials. - `username` string, required: Username. - `password` string, required: Password. - object: HMAC credentials. - `secretKey` string, required: Secret key. - `algorithm` 'HMAC_MD5' | 'HMAC_SHA_1' | 'HMAC_SHA_224' | 'HMAC_SHA_256' | 'HMAC_SHA_384' | 'HMAC_SHA_512', required: HMAC algorithm. - object: OAuth credentials. - `tokenUrl` string, required: Token URL. - `clientId` string: Client ID. - `clientSecret` string: Client secret. - `grantType` string, required: Grant type. - `scope` string: Scope. - `username` string: Username. - `password` string: Password. - `resource` string: Resource. - `refreshToken` string: Refresh token. - `headers` object: Set of key:value pairs that will be sent in a HTTP request as headers. - `clientCertificateId` string: Client certificate ID. - `maxBucketSize` integer: Specifies a maximum number of messages to be sent within a single request. - `windowSize` integer: A maximum number of concurrent connections (active requests) per client. - `connectTimeout` integer: Time in milliseconds sender system waits for connection acknowledgement until the connection is closed. - `readTimeout` integer: A maximum period of inactivity in milliseconds between two consecutive data packets. - `enabledSSLProtocols` string[]: Specifies which security protocols should be used to send a HTTP request. Multiple options can be used. - `headers` object: Set of key:value pairs that will be sent in a HTTP request as headers.Note: 'Authorization' header (if configured here for any reason) can be overridden with one from security config. - `responseRegex` string: Response regex. - `responseBodyRegex` string: Response body regex. - `rateLimit` integer: Limits the number of requests per second. - 6e71a232d29cf86cbe8cd24bd719c2050de4613347854f985c920dd3d0d3e33fFacebookSubscriptionRequest: Subscription group. - `subscriptionId` string, required: Subscription ID. Used as part of a URL path and must not include any characters that require URL encoding. You cannot change the ID once a subscription is created. - `name` string: A human-readable description for your subscription, can be changed at a later point. - `subscriptionGroupId` string: Subscription group identifier. Subscriptions with different group IDs for the same event will each receive the event independently, enabling multi-webhook delivery. - `events` union[], required: List of events available for a subscription. Note that a set of events available for each channel is different; subscription to events that are unavailable for a certain channel will be ignored. For more details, see the [availability table](https://www.infobip.com/docs/cpaas-x/subscriptions-management/event-subscriptions). If configuring inbound Subscription, check [inbound message configuration docs](https://www.infobip.com/docs/cpaas-x/subscriptions-management/inbound-message-configuration). - union - 'AUDIENCE_UPLOAD_STATUS' | 'CLICK' | 'CONSENT_UPDATE' | 'DELIVERY' | 'INBOUND_MESSAGE' | 'SEEN' - 6e71a232d29cf86cbe8cd24bd719c2050de4613347854f985c920dd3d0d3e33fFormatAwareFacebookEvents - `event` 'AUDIENCE_UPLOAD_STATUS' | 'CLICK' | 'CONSENT_UPDATE' | 'DELIVERY' | 'INBOUND_MESSAGE' | 'SEEN', required - `format` string, required: Format which you want to assign to the event. For more information about available formats and their payload, check our [Event Formats](https://www.infobip.com/docs/cpaas-x/subscriptions-management/event-formats) page. - `criteria` 6e71a232d29cf86cbe8cd24bd719c2050de4613347854f985c920dd3d0d3e33fApplicationEntityPair[]: Application and Entity pair to match. You can set the rule to match only Application or only Entity if necessary, omitting the other item. - `applicationId` string: CPaaS X property identifying an application, an use case or an environment on your system. Should only be set if you are using CPaaS X Applications with your traffic. - `entityId` string: CPaaS X property identifying an unique actor on your system. Should only be set if you are using CPaaS X Applications with your traffic. - `callsConfigurationId` string: CPaaS X calls configuration identifier. Should only be set if you are using CPaaS X Applications with your traffic. - `resources` string[]: List of resources to match. At the moment, this could only be a sender name (whether numeric or alpha) used on message submit. - `users` string[]: List of users to match. You can provide usernames from your account. - `keywords` string[]: List of keywords to match. Route inbound messages by their first word. A customer texting STOP or ORDER to your number triggers only the subscriptions matching that keyword. - `profile` 6e71a232d29cf86cbe8cd24bd719c2050de4613347854f985c920dd3d0d3e33fProfileRequest, required: Notification profile object holding the settings for your webhook URL and a reference to security settings. You can provide full definition of a notification profile and security settings if you want to create new items, or provide an ID of an existing profile to reuse it. If you want to reuse an existing profile, do not provide any other notification profile and security settings properties. - `profileId` string, required: ID of a notification profile. This identifier will be used as part of a URL path and must not include any characters that require URL encoding. You cannot change the ID once an item is created. - `webhook` 6e71a232d29cf86cbe8cd24bd719c2050de4613347854f985c920dd3d0d3e33fWebhook: Webhook configuration. - `contentType` string - `notifyUrl` string, required: Your webhook URL, where the notifications will be sent to. - `security` 6e71a232d29cf86cbe8cd24bd719c2050de4613347854f985c920dd3d0d3e33fSecurityRequest: Security settings object holding the authentication settings necessary to access your webhook. Should only be provided if you are creating a new profile and settings; otherwise it will be ignored. - `authId` string, required: Unique security setting ID. Used as part of a URL path and must not include any characters that require URL encoding. You cannot change the ID once an item is created. - `type` 'BASIC' | 'HMAC' | 'OAUTH': Credentials type. - `credentials` union: Webhook security credentials. - object: Basic credentials. - `username` string, required: Username. - `password` string, required: Password. - object: HMAC credentials. - `secretKey` string, required: Secret key. - `algorithm` 'HMAC_MD5' | 'HMAC_SHA_1' | 'HMAC_SHA_224' | 'HMAC_SHA_256' | 'HMAC_SHA_384' | 'HMAC_SHA_512', required: HMAC algorithm. - object: OAuth credentials. - `tokenUrl` string, required: Token URL. - `clientId` string: Client ID. - `clientSecret` string: Client secret. - `grantType` string, required: Grant type. - `scope` string: Scope. - `username` string: Username. - `password` string: Password. - `resource` string: Resource. - `refreshToken` string: Refresh token. - `headers` object: Set of key:value pairs that will be sent in a HTTP request as headers. - `clientCertificateId` string: Client certificate ID. - `maxBucketSize` integer: Specifies a maximum number of messages to be sent within a single request. - `windowSize` integer: A maximum number of concurrent connections (active requests) per client. - `connectTimeout` integer: Time in milliseconds sender system waits for connection acknowledgement until the connection is closed. - `readTimeout` integer: A maximum period of inactivity in milliseconds between two consecutive data packets. - `enabledSSLProtocols` string[]: Specifies which security protocols should be used to send a HTTP request. Multiple options can be used. - `headers` object: Set of key:value pairs that will be sent in a HTTP request as headers.Note: 'Authorization' header (if configured here for any reason) can be overridden with one from security config. - `responseRegex` string: Response regex. - `responseBodyRegex` string: Response body regex. - `rateLimit` integer: Limits the number of requests per second. - 6e71a232d29cf86cbe8cd24bd719c2050de4613347854f985c920dd3d0d3e33fKakaoAlimSubscriptionRequest: Subscription group. - `subscriptionId` string, required: Subscription ID. Used as part of a URL path and must not include any characters that require URL encoding. You cannot change the ID once a subscription is created. - `name` string: A human-readable description for your subscription, can be changed at a later point. - `subscriptionGroupId` string: Subscription group identifier. Subscriptions with different group IDs for the same event will each receive the event independently, enabling multi-webhook delivery. - `events` 6e71a232d29cf86cbe8cd24bd719c2050de4613347854f985c920dd3d0d3e33fSimpleKakaoAlimEvents[], required: List of events available for a subscription. Note that a set of events available for each channel is different; subscription to events that are unavailable for a certain channel will be ignored. For more details, see the [availability table](https://www.infobip.com/docs/cpaas-x/subscriptions-management/event-subscriptions). If configuring inbound Subscription, check [inbound message configuration docs](https://www.infobip.com/docs/cpaas-x/subscriptions-management/inbound-message-configuration). - `criteria` 6e71a232d29cf86cbe8cd24bd719c2050de4613347854f985c920dd3d0d3e33fApplicationEntityPair[]: Application and Entity pair to match. You can set the rule to match only Application or only Entity if necessary, omitting the other item. - `applicationId` string: CPaaS X property identifying an application, an use case or an environment on your system. Should only be set if you are using CPaaS X Applications with your traffic. - `entityId` string: CPaaS X property identifying an unique actor on your system. Should only be set if you are using CPaaS X Applications with your traffic. - `callsConfigurationId` string: CPaaS X calls configuration identifier. Should only be set if you are using CPaaS X Applications with your traffic. - `resources` string[]: List of resources to match. At the moment, this could only be a sender name (whether numeric or alpha) used on message submit. - `users` string[]: List of users to match. You can provide usernames from your account. - `keywords` string[]: List of keywords to match. Route inbound messages by their first word. A customer texting STOP or ORDER to your number triggers only the subscriptions matching that keyword. - `profile` 6e71a232d29cf86cbe8cd24bd719c2050de4613347854f985c920dd3d0d3e33fProfileRequest, required: Notification profile object holding the settings for your webhook URL and a reference to security settings. You can provide full definition of a notification profile and security settings if you want to create new items, or provide an ID of an existing profile to reuse it. If you want to reuse an existing profile, do not provide any other notification profile and security settings properties. - `profileId` string, required: ID of a notification profile. This identifier will be used as part of a URL path and must not include any characters that require URL encoding. You cannot change the ID once an item is created. - `webhook` 6e71a232d29cf86cbe8cd24bd719c2050de4613347854f985c920dd3d0d3e33fWebhook: Webhook configuration. - `contentType` string - `notifyUrl` string, required: Your webhook URL, where the notifications will be sent to. - `security` 6e71a232d29cf86cbe8cd24bd719c2050de4613347854f985c920dd3d0d3e33fSecurityRequest: Security settings object holding the authentication settings necessary to access your webhook. Should only be provided if you are creating a new profile and settings; otherwise it will be ignored. - `authId` string, required: Unique security setting ID. Used as part of a URL path and must not include any characters that require URL encoding. You cannot change the ID once an item is created. - `type` 'BASIC' | 'HMAC' | 'OAUTH': Credentials type. - `credentials` union: Webhook security credentials. - object: Basic credentials. - `username` string, required: Username. - `password` string, required: Password. - object: HMAC credentials. - `secretKey` string, required: Secret key. - `algorithm` 'HMAC_MD5' | 'HMAC_SHA_1' | 'HMAC_SHA_224' | 'HMAC_SHA_256' | 'HMAC_SHA_384' | 'HMAC_SHA_512', required: HMAC algorithm. - object: OAuth credentials. - `tokenUrl` string, required: Token URL. - `clientId` string: Client ID. - `clientSecret` string: Client secret. - `grantType` string, required: Grant type. - `scope` string: Scope. - `username` string: Username. - `password` string: Password. - `resource` string: Resource. - `refreshToken` string: Refresh token. - `headers` object: Set of key:value pairs that will be sent in a HTTP request as headers. - `clientCertificateId` string: Client certificate ID. - `maxBucketSize` integer: Specifies a maximum number of messages to be sent within a single request. - `windowSize` integer: A maximum number of concurrent connections (active requests) per client. - `connectTimeout` integer: Time in milliseconds sender system waits for connection acknowledgement until the connection is closed. - `readTimeout` integer: A maximum period of inactivity in milliseconds between two consecutive data packets. - `enabledSSLProtocols` string[]: Specifies which security protocols should be used to send a HTTP request. Multiple options can be used. - `headers` object: Set of key:value pairs that will be sent in a HTTP request as headers.Note: 'Authorization' header (if configured here for any reason) can be overridden with one from security config. - `responseRegex` string: Response regex. - `responseBodyRegex` string: Response body regex. - `rateLimit` integer: Limits the number of requests per second. - 6e71a232d29cf86cbe8cd24bd719c2050de4613347854f985c920dd3d0d3e33fKakaoBrandMessageSubscriptionRequest: Subscription group. - `subscriptionId` string, required: Subscription ID. Used as part of a URL path and must not include any characters that require URL encoding. You cannot change the ID once a subscription is created. - `name` string: A human-readable description for your subscription, can be changed at a later point. - `subscriptionGroupId` string: Subscription group identifier. Subscriptions with different group IDs for the same event will each receive the event independently, enabling multi-webhook delivery. - `events` 6e71a232d29cf86cbe8cd24bd719c2050de4613347854f985c920dd3d0d3e33fSimpleKakaoBrandMessageEvents[], required: List of events available for a subscription. Note that a set of events available for each channel is different; subscription to events that are unavailable for a certain channel will be ignored. For more details, see the [availability table](https://www.infobip.com/docs/cpaas-x/subscriptions-management/event-subscriptions). If configuring inbound Subscription, check [inbound message configuration docs](https://www.infobip.com/docs/cpaas-x/subscriptions-management/inbound-message-configuration). - `criteria` 6e71a232d29cf86cbe8cd24bd719c2050de4613347854f985c920dd3d0d3e33fApplicationEntityPair[]: Application and Entity pair to match. You can set the rule to match only Application or only Entity if necessary, omitting the other item. - `applicationId` string: CPaaS X property identifying an application, an use case or an environment on your system. Should only be set if you are using CPaaS X Applications with your traffic. - `entityId` string: CPaaS X property identifying an unique actor on your system. Should only be set if you are using CPaaS X Applications with your traffic. - `callsConfigurationId` string: CPaaS X calls configuration identifier. Should only be set if you are using CPaaS X Applications with your traffic. - `resources` string[]: List of resources to match. At the moment, this could only be a sender name (whether numeric or alpha) used on message submit. - `users` string[]: List of users to match. You can provide usernames from your account. - `keywords` string[]: List of keywords to match. Route inbound messages by their first word. A customer texting STOP or ORDER to your number triggers only the subscriptions matching that keyword. - `profile` 6e71a232d29cf86cbe8cd24bd719c2050de4613347854f985c920dd3d0d3e33fProfileRequest, required: Notification profile object holding the settings for your webhook URL and a reference to security settings. You can provide full definition of a notification profile and security settings if you want to create new items, or provide an ID of an existing profile to reuse it. If you want to reuse an existing profile, do not provide any other notification profile and security settings properties. - `profileId` string, required: ID of a notification profile. This identifier will be used as part of a URL path and must not include any characters that require URL encoding. You cannot change the ID once an item is created. - `webhook` 6e71a232d29cf86cbe8cd24bd719c2050de4613347854f985c920dd3d0d3e33fWebhook: Webhook configuration. - `contentType` string - `notifyUrl` string, required: Your webhook URL, where the notifications will be sent to. - `security` 6e71a232d29cf86cbe8cd24bd719c2050de4613347854f985c920dd3d0d3e33fSecurityRequest: Security settings object holding the authentication settings necessary to access your webhook. Should only be provided if you are creating a new profile and settings; otherwise it will be ignored. - `authId` string, required: Unique security setting ID. Used as part of a URL path and must not include any characters that require URL encoding. You cannot change the ID once an item is created. - `type` 'BASIC' | 'HMAC' | 'OAUTH': Credentials type. - `credentials` union: Webhook security credentials. - object: Basic credentials. - `username` string, required: Username. - `password` string, required: Password. - object: HMAC credentials. - `secretKey` string, required: Secret key. - `algorithm` 'HMAC_MD5' | 'HMAC_SHA_1' | 'HMAC_SHA_224' | 'HMAC_SHA_256' | 'HMAC_SHA_384' | 'HMAC_SHA_512', required: HMAC algorithm. - object: OAuth credentials. - `tokenUrl` string, required: Token URL. - `clientId` string: Client ID. - `clientSecret` string: Client secret. - `grantType` string, required: Grant type. - `scope` string: Scope. - `username` string: Username. - `password` string: Password. - `resource` string: Resource. - `refreshToken` string: Refresh token. - `headers` object: Set of key:value pairs that will be sent in a HTTP request as headers. - `clientCertificateId` string: Client certificate ID. - `maxBucketSize` integer: Specifies a maximum number of messages to be sent within a single request. - `windowSize` integer: A maximum number of concurrent connections (active requests) per client. - `connectTimeout` integer: Time in milliseconds sender system waits for connection acknowledgement until the connection is closed. - `readTimeout` integer: A maximum period of inactivity in milliseconds between two consecutive data packets. - `enabledSSLProtocols` string[]: Specifies which security protocols should be used to send a HTTP request. Multiple options can be used. - `headers` object: Set of key:value pairs that will be sent in a HTTP request as headers.Note: 'Authorization' header (if configured here for any reason) can be overridden with one from security config. - `responseRegex` string: Response regex. - `responseBodyRegex` string: Response body regex. - `rateLimit` integer: Limits the number of requests per second. - 6e71a232d29cf86cbe8cd24bd719c2050de4613347854f985c920dd3d0d3e33fLineSubscriptionRequest: Subscription group. - `subscriptionId` string, required: Subscription ID. Used as part of a URL path and must not include any characters that require URL encoding. You cannot change the ID once a subscription is created. - `name` string: A human-readable description for your subscription, can be changed at a later point. - `subscriptionGroupId` string: Subscription group identifier. Subscriptions with different group IDs for the same event will each receive the event independently, enabling multi-webhook delivery. - `events` 6e71a232d29cf86cbe8cd24bd719c2050de4613347854f985c920dd3d0d3e33fSimpleLineEvents[], required: List of events available for a subscription. Note that a set of events available for each channel is different; subscription to events that are unavailable for a certain channel will be ignored. For more details, see the [availability table](https://www.infobip.com/docs/cpaas-x/subscriptions-management/event-subscriptions). If configuring inbound Subscription, check [inbound message configuration docs](https://www.infobip.com/docs/cpaas-x/subscriptions-management/inbound-message-configuration). - `criteria` 6e71a232d29cf86cbe8cd24bd719c2050de4613347854f985c920dd3d0d3e33fApplicationEntityPair[]: Application and Entity pair to match. You can set the rule to match only Application or only Entity if necessary, omitting the other item. - `applicationId` string: CPaaS X property identifying an application, an use case or an environment on your system. Should only be set if you are using CPaaS X Applications with your traffic. - `entityId` string: CPaaS X property identifying an unique actor on your system. Should only be set if you are using CPaaS X Applications with your traffic. - `callsConfigurationId` string: CPaaS X calls configuration identifier. Should only be set if you are using CPaaS X Applications with your traffic. - `resources` string[]: List of resources to match. At the moment, this could only be a sender name (whether numeric or alpha) used on message submit. - `users` string[]: List of users to match. You can provide usernames from your account. - `keywords` string[]: List of keywords to match. Route inbound messages by their first word. A customer texting STOP or ORDER to your number triggers only the subscriptions matching that keyword. - `profile` 6e71a232d29cf86cbe8cd24bd719c2050de4613347854f985c920dd3d0d3e33fProfileRequest, required: Notification profile object holding the settings for your webhook URL and a reference to security settings. You can provide full definition of a notification profile and security settings if you want to create new items, or provide an ID of an existing profile to reuse it. If you want to reuse an existing profile, do not provide any other notification profile and security settings properties. - `profileId` string, required: ID of a notification profile. This identifier will be used as part of a URL path and must not include any characters that require URL encoding. You cannot change the ID once an item is created. - `webhook` 6e71a232d29cf86cbe8cd24bd719c2050de4613347854f985c920dd3d0d3e33fWebhook: Webhook configuration. - `contentType` string - `notifyUrl` string, required: Your webhook URL, where the notifications will be sent to. - `security` 6e71a232d29cf86cbe8cd24bd719c2050de4613347854f985c920dd3d0d3e33fSecurityRequest: Security settings object holding the authentication settings necessary to access your webhook. Should only be provided if you are creating a new profile and settings; otherwise it will be ignored. - `authId` string, required: Unique security setting ID. Used as part of a URL path and must not include any characters that require URL encoding. You cannot change the ID once an item is created. - `type` 'BASIC' | 'HMAC' | 'OAUTH': Credentials type. - `credentials` union: Webhook security credentials. - object: Basic credentials. - `username` string, required: Username. - `password` string, required: Password. - object: HMAC credentials. - `secretKey` string, required: Secret key. - `algorithm` 'HMAC_MD5' | 'HMAC_SHA_1' | 'HMAC_SHA_224' | 'HMAC_SHA_256' | 'HMAC_SHA_384' | 'HMAC_SHA_512', required: HMAC algorithm. - object: OAuth credentials. - `tokenUrl` string, required: Token URL. - `clientId` string: Client ID. - `clientSecret` string: Client secret. - `grantType` string, required: Grant type. - `scope` string: Scope. - `username` string: Username. - `password` string: Password. - `resource` string: Resource. - `refreshToken` string: Refresh token. - `headers` object: Set of key:value pairs that will be sent in a HTTP request as headers. - `clientCertificateId` string: Client certificate ID. - `maxBucketSize` integer: Specifies a maximum number of messages to be sent within a single request. - `windowSize` integer: A maximum number of concurrent connections (active requests) per client. - `connectTimeout` integer: Time in milliseconds sender system waits for connection acknowledgement until the connection is closed. - `readTimeout` integer: A maximum period of inactivity in milliseconds between two consecutive data packets. - `enabledSSLProtocols` string[]: Specifies which security protocols should be used to send a HTTP request. Multiple options can be used. - `headers` object: Set of key:value pairs that will be sent in a HTTP request as headers.Note: 'Authorization' header (if configured here for any reason) can be overridden with one from security config. - `responseRegex` string: Response regex. - `responseBodyRegex` string: Response body regex. - `rateLimit` integer: Limits the number of requests per second. - 6e71a232d29cf86cbe8cd24bd719c2050de4613347854f985c920dd3d0d3e33fMmsSubscriptionRequest: Subscription group. - `subscriptionId` string, required: Subscription ID. Used as part of a URL path and must not include any characters that require URL encoding. You cannot change the ID once a subscription is created. - `name` string: A human-readable description for your subscription, can be changed at a later point. - `subscriptionGroupId` string: Subscription group identifier. Subscriptions with different group IDs for the same event will each receive the event independently, enabling multi-webhook delivery. - `events` union[], required: List of events available for a subscription. Note that a set of events available for each channel is different; subscription to events that are unavailable for a certain channel will be ignored. For more details, see the [availability table](https://www.infobip.com/docs/cpaas-x/subscriptions-management/event-subscriptions). If configuring inbound Subscription, check [inbound message configuration docs](https://www.infobip.com/docs/cpaas-x/subscriptions-management/inbound-message-configuration). - union - 'CLICK' | 'DELIVERY' | 'INBOUND_MESSAGE' - 6e71a232d29cf86cbe8cd24bd719c2050de4613347854f985c920dd3d0d3e33fFormatAwareMmsEvents - `event` 'CLICK' | 'DELIVERY' | 'INBOUND_MESSAGE', required - `format` string, required: Format which you want to assign to the event. For more information about available formats and their payload, check our [Event Formats](https://www.infobip.com/docs/cpaas-x/subscriptions-management/event-formats) page. - `criteria` 6e71a232d29cf86cbe8cd24bd719c2050de4613347854f985c920dd3d0d3e33fApplicationEntityPair[]: Application and Entity pair to match. You can set the rule to match only Application or only Entity if necessary, omitting the other item. - `applicationId` string: CPaaS X property identifying an application, an use case or an environment on your system. Should only be set if you are using CPaaS X Applications with your traffic. - `entityId` string: CPaaS X property identifying an unique actor on your system. Should only be set if you are using CPaaS X Applications with your traffic. - `callsConfigurationId` string: CPaaS X calls configuration identifier. Should only be set if you are using CPaaS X Applications with your traffic. - `resources` string[]: List of resources to match. At the moment, this could only be a sender name (whether numeric or alpha) used on message submit. - `users` string[]: List of users to match. You can provide usernames from your account. - `keywords` string[]: List of keywords to match. Route inbound messages by their first word. A customer texting STOP or ORDER to your number triggers only the subscriptions matching that keyword. - `profile` 6e71a232d29cf86cbe8cd24bd719c2050de4613347854f985c920dd3d0d3e33fProfileRequest, required: Notification profile object holding the settings for your webhook URL and a reference to security settings. You can provide full definition of a notification profile and security settings if you want to create new items, or provide an ID of an existing profile to reuse it. If you want to reuse an existing profile, do not provide any other notification profile and security settings properties. - `profileId` string, required: ID of a notification profile. This identifier will be used as part of a URL path and must not include any characters that require URL encoding. You cannot change the ID once an item is created. - `webhook` 6e71a232d29cf86cbe8cd24bd719c2050de4613347854f985c920dd3d0d3e33fWebhook: Webhook configuration. - `contentType` string - `notifyUrl` string, required: Your webhook URL, where the notifications will be sent to. - `security` 6e71a232d29cf86cbe8cd24bd719c2050de4613347854f985c920dd3d0d3e33fSecurityRequest: Security settings object holding the authentication settings necessary to access your webhook. Should only be provided if you are creating a new profile and settings; otherwise it will be ignored. - `authId` string, required: Unique security setting ID. Used as part of a URL path and must not include any characters that require URL encoding. You cannot change the ID once an item is created. - `type` 'BASIC' | 'HMAC' | 'OAUTH': Credentials type. - `credentials` union: Webhook security credentials. - object: Basic credentials. - `username` string, required: Username. - `password` string, required: Password. - object: HMAC credentials. - `secretKey` string, required: Secret key. - `algorithm` 'HMAC_MD5' | 'HMAC_SHA_1' | 'HMAC_SHA_224' | 'HMAC_SHA_256' | 'HMAC_SHA_384' | 'HMAC_SHA_512', required: HMAC algorithm. - object: OAuth credentials. - `tokenUrl` string, required: Token URL. - `clientId` string: Client ID. - `clientSecret` string: Client secret. - `grantType` string, required: Grant type. - `scope` string: Scope. - `username` string: Username. - `password` string: Password. - `resource` string: Resource. - `refreshToken` string: Refresh token. - `headers` object: Set of key:value pairs that will be sent in a HTTP request as headers. - `clientCertificateId` string: Client certificate ID. - `maxBucketSize` integer: Specifies a maximum number of messages to be sent within a single request. - `windowSize` integer: A maximum number of concurrent connections (active requests) per client. - `connectTimeout` integer: Time in milliseconds sender system waits for connection acknowledgement until the connection is closed. - `readTimeout` integer: A maximum period of inactivity in milliseconds between two consecutive data packets. - `enabledSSLProtocols` string[]: Specifies which security protocols should be used to send a HTTP request. Multiple options can be used. - `headers` object: Set of key:value pairs that will be sent in a HTTP request as headers.Note: 'Authorization' header (if configured here for any reason) can be overridden with one from security config. - `responseRegex` string: Response regex. - `responseBodyRegex` string: Response body regex. - `rateLimit` integer: Limits the number of requests per second. - 6e71a232d29cf86cbe8cd24bd719c2050de4613347854f985c920dd3d0d3e33fMobileIdentitySubscriptionRequest: Subscription group. - `subscriptionId` string, required: Subscription ID. Used as part of a URL path and must not include any characters that require URL encoding. You cannot change the ID once a subscription is created. - `name` string: A human-readable description for your subscription, can be changed at a later point. - `subscriptionGroupId` string: Subscription group identifier. Subscriptions with different group IDs for the same event will each receive the event independently, enabling multi-webhook delivery. - `events` union[], required: List of events available for a subscription. Note that a set of events available for each channel is different; subscription to events that are unavailable for a certain channel will be ignored. For more details, see the [availability table](https://www.infobip.com/docs/cpaas-x/subscriptions-management/event-subscriptions). If configuring inbound Subscription, check [inbound message configuration docs](https://www.infobip.com/docs/cpaas-x/subscriptions-management/inbound-message-configuration). - union - 'SILENT_VERIFICATION' - 6e71a232d29cf86cbe8cd24bd719c2050de4613347854f985c920dd3d0d3e33fFormatAwareMobileIdentityEvents - `event` 'SILENT_VERIFICATION', required - `format` string, required: Format which you want to assign to the event. For more information about available formats and their payload, check our [Event Formats](https://www.infobip.com/docs/cpaas-x/subscriptions-management/event-formats) page. - `criteria` 6e71a232d29cf86cbe8cd24bd719c2050de4613347854f985c920dd3d0d3e33fApplicationEntityPair[]: Application and Entity pair to match. You can set the rule to match only Application or only Entity if necessary, omitting the other item. - `applicationId` string: CPaaS X property identifying an application, an use case or an environment on your system. Should only be set if you are using CPaaS X Applications with your traffic. - `entityId` string: CPaaS X property identifying an unique actor on your system. Should only be set if you are using CPaaS X Applications with your traffic. - `callsConfigurationId` string: CPaaS X calls configuration identifier. Should only be set if you are using CPaaS X Applications with your traffic. - `resources` string[]: List of resources to match. At the moment, this could only be a sender name (whether numeric or alpha) used on message submit. - `users` string[]: List of users to match. You can provide usernames from your account. - `keywords` string[]: List of keywords to match. Route inbound messages by their first word. A customer texting STOP or ORDER to your number triggers only the subscriptions matching that keyword. - `profile` 6e71a232d29cf86cbe8cd24bd719c2050de4613347854f985c920dd3d0d3e33fProfileRequest, required: Notification profile object holding the settings for your webhook URL and a reference to security settings. You can provide full definition of a notification profile and security settings if you want to create new items, or provide an ID of an existing profile to reuse it. If you want to reuse an existing profile, do not provide any other notification profile and security settings properties. - `profileId` string, required: ID of a notification profile. This identifier will be used as part of a URL path and must not include any characters that require URL encoding. You cannot change the ID once an item is created. - `webhook` 6e71a232d29cf86cbe8cd24bd719c2050de4613347854f985c920dd3d0d3e33fWebhook: Webhook configuration. - `contentType` string - `notifyUrl` string, required: Your webhook URL, where the notifications will be sent to. - `security` 6e71a232d29cf86cbe8cd24bd719c2050de4613347854f985c920dd3d0d3e33fSecurityRequest: Security settings object holding the authentication settings necessary to access your webhook. Should only be provided if you are creating a new profile and settings; otherwise it will be ignored. - `authId` string, required: Unique security setting ID. Used as part of a URL path and must not include any characters that require URL encoding. You cannot change the ID once an item is created. - `type` 'BASIC' | 'HMAC' | 'OAUTH': Credentials type. - `credentials` union: Webhook security credentials. - object: Basic credentials. - `username` string, required: Username. - `password` string, required: Password. - object: HMAC credentials. - `secretKey` string, required: Secret key. - `algorithm` 'HMAC_MD5' | 'HMAC_SHA_1' | 'HMAC_SHA_224' | 'HMAC_SHA_256' | 'HMAC_SHA_384' | 'HMAC_SHA_512', required: HMAC algorithm. - object: OAuth credentials. - `tokenUrl` string, required: Token URL. - `clientId` string: Client ID. - `clientSecret` string: Client secret. - `grantType` string, required: Grant type. - `scope` string: Scope. - `username` string: Username. - `password` string: Password. - `resource` string: Resource. - `refreshToken` string: Refresh token. - `headers` object: Set of key:value pairs that will be sent in a HTTP request as headers. - `clientCertificateId` string: Client certificate ID. - `maxBucketSize` integer: Specifies a maximum number of messages to be sent within a single request. - `windowSize` integer: A maximum number of concurrent connections (active requests) per client. - `connectTimeout` integer: Time in milliseconds sender system waits for connection acknowledgement until the connection is closed. - `readTimeout` integer: A maximum period of inactivity in milliseconds between two consecutive data packets. - `enabledSSLProtocols` string[]: Specifies which security protocols should be used to send a HTTP request. Multiple options can be used. - `headers` object: Set of key:value pairs that will be sent in a HTTP request as headers.Note: 'Authorization' header (if configured here for any reason) can be overridden with one from security config. - `responseRegex` string: Response regex. - `responseBodyRegex` string: Response body regex. - `rateLimit` integer: Limits the number of requests per second. - 6e71a232d29cf86cbe8cd24bd719c2050de4613347854f985c920dd3d0d3e33fMobilePushSubscriptionRequest: Subscription group. - `subscriptionId` string, required: Subscription ID. Used as part of a URL path and must not include any characters that require URL encoding. You cannot change the ID once a subscription is created. - `name` string: A human-readable description for your subscription, can be changed at a later point. - `subscriptionGroupId` string: Subscription group identifier. Subscriptions with different group IDs for the same event will each receive the event independently, enabling multi-webhook delivery. - `events` 6e71a232d29cf86cbe8cd24bd719c2050de4613347854f985c920dd3d0d3e33fSimpleMobilePushEvents[], required: List of events available for a subscription. Note that a set of events available for each channel is different; subscription to events that are unavailable for a certain channel will be ignored. For more details, see the [availability table](https://www.infobip.com/docs/cpaas-x/subscriptions-management/event-subscriptions). If configuring inbound Subscription, check [inbound message configuration docs](https://www.infobip.com/docs/cpaas-x/subscriptions-management/inbound-message-configuration). - `criteria` 6e71a232d29cf86cbe8cd24bd719c2050de4613347854f985c920dd3d0d3e33fApplicationEntityPair[]: Application and Entity pair to match. You can set the rule to match only Application or only Entity if necessary, omitting the other item. - `applicationId` string: CPaaS X property identifying an application, an use case or an environment on your system. Should only be set if you are using CPaaS X Applications with your traffic. - `entityId` string: CPaaS X property identifying an unique actor on your system. Should only be set if you are using CPaaS X Applications with your traffic. - `callsConfigurationId` string: CPaaS X calls configuration identifier. Should only be set if you are using CPaaS X Applications with your traffic. - `resources` string[]: List of resources to match. At the moment, this could only be a sender name (whether numeric or alpha) used on message submit. - `users` string[]: List of users to match. You can provide usernames from your account. - `keywords` string[]: List of keywords to match. Route inbound messages by their first word. A customer texting STOP or ORDER to your number triggers only the subscriptions matching that keyword. - `profile` 6e71a232d29cf86cbe8cd24bd719c2050de4613347854f985c920dd3d0d3e33fProfileRequest, required: Notification profile object holding the settings for your webhook URL and a reference to security settings. You can provide full definition of a notification profile and security settings if you want to create new items, or provide an ID of an existing profile to reuse it. If you want to reuse an existing profile, do not provide any other notification profile and security settings properties. - `profileId` string, required: ID of a notification profile. This identifier will be used as part of a URL path and must not include any characters that require URL encoding. You cannot change the ID once an item is created. - `webhook` 6e71a232d29cf86cbe8cd24bd719c2050de4613347854f985c920dd3d0d3e33fWebhook: Webhook configuration. - `contentType` string - `notifyUrl` string, required: Your webhook URL, where the notifications will be sent to. - `security` 6e71a232d29cf86cbe8cd24bd719c2050de4613347854f985c920dd3d0d3e33fSecurityRequest: Security settings object holding the authentication settings necessary to access your webhook. Should only be provided if you are creating a new profile and settings; otherwise it will be ignored. - `authId` string, required: Unique security setting ID. Used as part of a URL path and must not include any characters that require URL encoding. You cannot change the ID once an item is created. - `type` 'BASIC' | 'HMAC' | 'OAUTH': Credentials type. - `credentials` union: Webhook security credentials. - object: Basic credentials. - `username` string, required: Username. - `password` string, required: Password. - object: HMAC credentials. - `secretKey` string, required: Secret key. - `algorithm` 'HMAC_MD5' | 'HMAC_SHA_1' | 'HMAC_SHA_224' | 'HMAC_SHA_256' | 'HMAC_SHA_384' | 'HMAC_SHA_512', required: HMAC algorithm. - object: OAuth credentials. - `tokenUrl` string, required: Token URL. - `clientId` string: Client ID. - `clientSecret` string: Client secret. - `grantType` string, required: Grant type. - `scope` string: Scope. - `username` string: Username. - `password` string: Password. - `resource` string: Resource. - `refreshToken` string: Refresh token. - `headers` object: Set of key:value pairs that will be sent in a HTTP request as headers. - `clientCertificateId` string: Client certificate ID. - `maxBucketSize` integer: Specifies a maximum number of messages to be sent within a single request. - `windowSize` integer: A maximum number of concurrent connections (active requests) per client. - `connectTimeout` integer: Time in milliseconds sender system waits for connection acknowledgement until the connection is closed. - `readTimeout` integer: A maximum period of inactivity in milliseconds between two consecutive data packets. - `enabledSSLProtocols` string[]: Specifies which security protocols should be used to send a HTTP request. Multiple options can be used. - `headers` object: Set of key:value pairs that will be sent in a HTTP request as headers.Note: 'Authorization' header (if configured here for any reason) can be overridden with one from security config. - `responseRegex` string: Response regex. - `responseBodyRegex` string: Response body regex. - `rateLimit` integer: Limits the number of requests per second. - 6e71a232d29cf86cbe8cd24bd719c2050de4613347854f985c920dd3d0d3e33fNumberLookupSubscriptionRequest: Subscription group. - `subscriptionId` string, required: Subscription ID. Used as part of a URL path and must not include any characters that require URL encoding. You cannot change the ID once a subscription is created. - `name` string: A human-readable description for your subscription, can be changed at a later point. - `subscriptionGroupId` string: Subscription group identifier. Subscriptions with different group IDs for the same event will each receive the event independently, enabling multi-webhook delivery. - `events` 6e71a232d29cf86cbe8cd24bd719c2050de4613347854f985c920dd3d0d3e33fSimpleNumberLookupEvents[], required: List of events available for a subscription. Note that a set of events available for each channel is different; subscription to events that are unavailable for a certain channel will be ignored. For more details, see the [availability table](https://www.infobip.com/docs/cpaas-x/subscriptions-management/event-subscriptions). If configuring inbound Subscription, check [inbound message configuration docs](https://www.infobip.com/docs/cpaas-x/subscriptions-management/inbound-message-configuration). - `criteria` 6e71a232d29cf86cbe8cd24bd719c2050de4613347854f985c920dd3d0d3e33fApplicationEntityPair[]: Application and Entity pair to match. You can set the rule to match only Application or only Entity if necessary, omitting the other item. - `applicationId` string: CPaaS X property identifying an application, an use case or an environment on your system. Should only be set if you are using CPaaS X Applications with your traffic. - `entityId` string: CPaaS X property identifying an unique actor on your system. Should only be set if you are using CPaaS X Applications with your traffic. - `callsConfigurationId` string: CPaaS X calls configuration identifier. Should only be set if you are using CPaaS X Applications with your traffic. - `resources` string[]: List of resources to match. At the moment, this could only be a sender name (whether numeric or alpha) used on message submit. - `users` string[]: List of users to match. You can provide usernames from your account. - `keywords` string[]: List of keywords to match. Route inbound messages by their first word. A customer texting STOP or ORDER to your number triggers only the subscriptions matching that keyword. - `profile` 6e71a232d29cf86cbe8cd24bd719c2050de4613347854f985c920dd3d0d3e33fProfileRequest, required: Notification profile object holding the settings for your webhook URL and a reference to security settings. You can provide full definition of a notification profile and security settings if you want to create new items, or provide an ID of an existing profile to reuse it. If you want to reuse an existing profile, do not provide any other notification profile and security settings properties. - `profileId` string, required: ID of a notification profile. This identifier will be used as part of a URL path and must not include any characters that require URL encoding. You cannot change the ID once an item is created. - `webhook` 6e71a232d29cf86cbe8cd24bd719c2050de4613347854f985c920dd3d0d3e33fWebhook: Webhook configuration. - `contentType` string - `notifyUrl` string, required: Your webhook URL, where the notifications will be sent to. - `security` 6e71a232d29cf86cbe8cd24bd719c2050de4613347854f985c920dd3d0d3e33fSecurityRequest: Security settings object holding the authentication settings necessary to access your webhook. Should only be provided if you are creating a new profile and settings; otherwise it will be ignored. - `authId` string, required: Unique security setting ID. Used as part of a URL path and must not include any characters that require URL encoding. You cannot change the ID once an item is created. - `type` 'BASIC' | 'HMAC' | 'OAUTH': Credentials type. - `credentials` union: Webhook security credentials. - object: Basic credentials. - `username` string, required: Username. - `password` string, required: Password. - object: HMAC credentials. - `secretKey` string, required: Secret key. - `algorithm` 'HMAC_MD5' | 'HMAC_SHA_1' | 'HMAC_SHA_224' | 'HMAC_SHA_256' | 'HMAC_SHA_384' | 'HMAC_SHA_512', required: HMAC algorithm. - object: OAuth credentials. - `tokenUrl` string, required: Token URL. - `clientId` string: Client ID. - `clientSecret` string: Client secret. - `grantType` string, required: Grant type. - `scope` string: Scope. - `username` string: Username. - `password` string: Password. - `resource` string: Resource. - `refreshToken` string: Refresh token. - `headers` object: Set of key:value pairs that will be sent in a HTTP request as headers. - `clientCertificateId` string: Client certificate ID. - `maxBucketSize` integer: Specifies a maximum number of messages to be sent within a single request. - `windowSize` integer: A maximum number of concurrent connections (active requests) per client. - `connectTimeout` integer: Time in milliseconds sender system waits for connection acknowledgement until the connection is closed. - `readTimeout` integer: A maximum period of inactivity in milliseconds between two consecutive data packets. - `enabledSSLProtocols` string[]: Specifies which security protocols should be used to send a HTTP request. Multiple options can be used. - `headers` object: Set of key:value pairs that will be sent in a HTTP request as headers.Note: 'Authorization' header (if configured here for any reason) can be overridden with one from security config. - `responseRegex` string: Response regex. - `responseBodyRegex` string: Response body regex. - `rateLimit` integer: Limits the number of requests per second. - 6e71a232d29cf86cbe8cd24bd719c2050de4613347854f985c920dd3d0d3e33fOpenChannelSubscriptionRequest: Subscription group. - `subscriptionId` string, required: Subscription ID. Used as part of a URL path and must not include any characters that require URL encoding. You cannot change the ID once a subscription is created. - `name` string: A human-readable description for your subscription, can be changed at a later point. - `subscriptionGroupId` string: Subscription group identifier. Subscriptions with different group IDs for the same event will each receive the event independently, enabling multi-webhook delivery. - `events` union[], required: List of events available for a subscription. Note that a set of events available for each channel is different; subscription to events that are unavailable for a certain channel will be ignored. For more details, see the [availability table](https://www.infobip.com/docs/cpaas-x/subscriptions-management/event-subscriptions). If configuring inbound Subscription, check [inbound message configuration docs](https://www.infobip.com/docs/cpaas-x/subscriptions-management/inbound-message-configuration). - union - 'DELIVERY' - 6e71a232d29cf86cbe8cd24bd719c2050de4613347854f985c920dd3d0d3e33fFormatAwareOpenChannelEvents - `event` 'DELIVERY', required - `format` string, required: Format which you want to assign to the event. For more information about available formats and their payload, check our [Event Formats](https://www.infobip.com/docs/cpaas-x/subscriptions-management/event-formats) page. - `criteria` 6e71a232d29cf86cbe8cd24bd719c2050de4613347854f985c920dd3d0d3e33fApplicationEntityPair[]: Application and Entity pair to match. You can set the rule to match only Application or only Entity if necessary, omitting the other item. - `applicationId` string: CPaaS X property identifying an application, an use case or an environment on your system. Should only be set if you are using CPaaS X Applications with your traffic. - `entityId` string: CPaaS X property identifying an unique actor on your system. Should only be set if you are using CPaaS X Applications with your traffic. - `callsConfigurationId` string: CPaaS X calls configuration identifier. Should only be set if you are using CPaaS X Applications with your traffic. - `resources` string[]: List of resources to match. At the moment, this could only be a sender name (whether numeric or alpha) used on message submit. - `users` string[]: List of users to match. You can provide usernames from your account. - `keywords` string[]: List of keywords to match. Route inbound messages by their first word. A customer texting STOP or ORDER to your number triggers only the subscriptions matching that keyword. - `profile` 6e71a232d29cf86cbe8cd24bd719c2050de4613347854f985c920dd3d0d3e33fProfileRequest, required: Notification profile object holding the settings for your webhook URL and a reference to security settings. You can provide full definition of a notification profile and security settings if you want to create new items, or provide an ID of an existing profile to reuse it. If you want to reuse an existing profile, do not provide any other notification profile and security settings properties. - `profileId` string, required: ID of a notification profile. This identifier will be used as part of a URL path and must not include any characters that require URL encoding. You cannot change the ID once an item is created. - `webhook` 6e71a232d29cf86cbe8cd24bd719c2050de4613347854f985c920dd3d0d3e33fWebhook: Webhook configuration. - `contentType` string - `notifyUrl` string, required: Your webhook URL, where the notifications will be sent to. - `security` 6e71a232d29cf86cbe8cd24bd719c2050de4613347854f985c920dd3d0d3e33fSecurityRequest: Security settings object holding the authentication settings necessary to access your webhook. Should only be provided if you are creating a new profile and settings; otherwise it will be ignored. - `authId` string, required: Unique security setting ID. Used as part of a URL path and must not include any characters that require URL encoding. You cannot change the ID once an item is created. - `type` 'BASIC' | 'HMAC' | 'OAUTH': Credentials type. - `credentials` union: Webhook security credentials. - object: Basic credentials. - `username` string, required: Username. - `password` string, required: Password. - object: HMAC credentials. - `secretKey` string, required: Secret key. - `algorithm` 'HMAC_MD5' | 'HMAC_SHA_1' | 'HMAC_SHA_224' | 'HMAC_SHA_256' | 'HMAC_SHA_384' | 'HMAC_SHA_512', required: HMAC algorithm. - object: OAuth credentials. - `tokenUrl` string, required: Token URL. - `clientId` string: Client ID. - `clientSecret` string: Client secret. - `grantType` string, required: Grant type. - `scope` string: Scope. - `username` string: Username. - `password` string: Password. - `resource` string: Resource. - `refreshToken` string: Refresh token. - `headers` object: Set of key:value pairs that will be sent in a HTTP request as headers. - `clientCertificateId` string: Client certificate ID. - `maxBucketSize` integer: Specifies a maximum number of messages to be sent within a single request. - `windowSize` integer: A maximum number of concurrent connections (active requests) per client. - `connectTimeout` integer: Time in milliseconds sender system waits for connection acknowledgement until the connection is closed. - `readTimeout` integer: A maximum period of inactivity in milliseconds between two consecutive data packets. - `enabledSSLProtocols` string[]: Specifies which security protocols should be used to send a HTTP request. Multiple options can be used. - `headers` object: Set of key:value pairs that will be sent in a HTTP request as headers.Note: 'Authorization' header (if configured here for any reason) can be overridden with one from security config. - `responseRegex` string: Response regex. - `responseBodyRegex` string: Response body regex. - `rateLimit` integer: Limits the number of requests per second. - 6e71a232d29cf86cbe8cd24bd719c2050de4613347854f985c920dd3d0d3e33fRcsSubscriptionRequest: Subscription group. - `subscriptionId` string, required: Subscription ID. Used as part of a URL path and must not include any characters that require URL encoding. You cannot change the ID once a subscription is created. - `name` string: A human-readable description for your subscription, can be changed at a later point. - `subscriptionGroupId` string: Subscription group identifier. Subscriptions with different group IDs for the same event will each receive the event independently, enabling multi-webhook delivery. - `events` 6e71a232d29cf86cbe8cd24bd719c2050de4613347854f985c920dd3d0d3e33fSimpleRcsEvents[], required: List of events available for a subscription. Note that a set of events available for each channel is different; subscription to events that are unavailable for a certain channel will be ignored. For more details, see the [availability table](https://www.infobip.com/docs/cpaas-x/subscriptions-management/event-subscriptions). If configuring inbound Subscription, check [inbound message configuration docs](https://www.infobip.com/docs/cpaas-x/subscriptions-management/inbound-message-configuration). - `criteria` 6e71a232d29cf86cbe8cd24bd719c2050de4613347854f985c920dd3d0d3e33fApplicationEntityPair[]: Application and Entity pair to match. You can set the rule to match only Application or only Entity if necessary, omitting the other item. - `applicationId` string: CPaaS X property identifying an application, an use case or an environment on your system. Should only be set if you are using CPaaS X Applications with your traffic. - `entityId` string: CPaaS X property identifying an unique actor on your system. Should only be set if you are using CPaaS X Applications with your traffic. - `callsConfigurationId` string: CPaaS X calls configuration identifier. Should only be set if you are using CPaaS X Applications with your traffic. - `resources` string[]: List of resources to match. At the moment, this could only be a sender name (whether numeric or alpha) used on message submit. - `users` string[]: List of users to match. You can provide usernames from your account. - `keywords` string[]: List of keywords to match. Route inbound messages by their first word. A customer texting STOP or ORDER to your number triggers only the subscriptions matching that keyword. - `profile` 6e71a232d29cf86cbe8cd24bd719c2050de4613347854f985c920dd3d0d3e33fProfileRequest, required: Notification profile object holding the settings for your webhook URL and a reference to security settings. You can provide full definition of a notification profile and security settings if you want to create new items, or provide an ID of an existing profile to reuse it. If you want to reuse an existing profile, do not provide any other notification profile and security settings properties. - `profileId` string, required: ID of a notification profile. This identifier will be used as part of a URL path and must not include any characters that require URL encoding. You cannot change the ID once an item is created. - `webhook` 6e71a232d29cf86cbe8cd24bd719c2050de4613347854f985c920dd3d0d3e33fWebhook: Webhook configuration. - `contentType` string - `notifyUrl` string, required: Your webhook URL, where the notifications will be sent to. - `security` 6e71a232d29cf86cbe8cd24bd719c2050de4613347854f985c920dd3d0d3e33fSecurityRequest: Security settings object holding the authentication settings necessary to access your webhook. Should only be provided if you are creating a new profile and settings; otherwise it will be ignored. - `authId` string, required: Unique security setting ID. Used as part of a URL path and must not include any characters that require URL encoding. You cannot change the ID once an item is created. - `type` 'BASIC' | 'HMAC' | 'OAUTH': Credentials type. - `credentials` union: Webhook security credentials. - object: Basic credentials. - `username` string, required: Username. - `password` string, required: Password. - object: HMAC credentials. - `secretKey` string, required: Secret key. - `algorithm` 'HMAC_MD5' | 'HMAC_SHA_1' | 'HMAC_SHA_224' | 'HMAC_SHA_256' | 'HMAC_SHA_384' | 'HMAC_SHA_512', required: HMAC algorithm. - object: OAuth credentials. - `tokenUrl` string, required: Token URL. - `clientId` string: Client ID. - `clientSecret` string: Client secret. - `grantType` string, required: Grant type. - `scope` string: Scope. - `username` string: Username. - `password` string: Password. - `resource` string: Resource. - `refreshToken` string: Refresh token. - `headers` object: Set of key:value pairs that will be sent in a HTTP request as headers. - `clientCertificateId` string: Client certificate ID. - `maxBucketSize` integer: Specifies a maximum number of messages to be sent within a single request. - `windowSize` integer: A maximum number of concurrent connections (active requests) per client. - `connectTimeout` integer: Time in milliseconds sender system waits for connection acknowledgement until the connection is closed. - `readTimeout` integer: A maximum period of inactivity in milliseconds between two consecutive data packets. - `enabledSSLProtocols` string[]: Specifies which security protocols should be used to send a HTTP request. Multiple options can be used. - `headers` object: Set of key:value pairs that will be sent in a HTTP request as headers.Note: 'Authorization' header (if configured here for any reason) can be overridden with one from security config. - `responseRegex` string: Response regex. - `responseBodyRegex` string: Response body regex. - `rateLimit` integer: Limits the number of requests per second. - 6e71a232d29cf86cbe8cd24bd719c2050de4613347854f985c920dd3d0d3e33fRegistrationSubscriptionRequest: Subscription group. - `subscriptionId` string, required: Subscription ID. Used as part of a URL path and must not include any characters that require URL encoding. You cannot change the ID once a subscription is created. - `name` string: A human-readable description for your subscription, can be changed at a later point. - `subscriptionGroupId` string: Subscription group identifier. Subscriptions with different group IDs for the same event will each receive the event independently, enabling multi-webhook delivery. - `events` 6e71a232d29cf86cbe8cd24bd719c2050de4613347854f985c920dd3d0d3e33fSimpleRegistrationEvents[], required: List of events available for a subscription. Note that a set of events available for each channel is different; subscription to events that are unavailable for a certain channel will be ignored. For more details, see the [availability table](https://www.infobip.com/docs/cpaas-x/subscriptions-management/event-subscriptions). If configuring inbound Subscription, check [inbound message configuration docs](https://www.infobip.com/docs/cpaas-x/subscriptions-management/inbound-message-configuration). - `criteria` 6e71a232d29cf86cbe8cd24bd719c2050de4613347854f985c920dd3d0d3e33fApplicationEntityPair[]: Application and Entity pair to match. You can set the rule to match only Application or only Entity if necessary, omitting the other item. - `applicationId` string: CPaaS X property identifying an application, an use case or an environment on your system. Should only be set if you are using CPaaS X Applications with your traffic. - `entityId` string: CPaaS X property identifying an unique actor on your system. Should only be set if you are using CPaaS X Applications with your traffic. - `callsConfigurationId` string: CPaaS X calls configuration identifier. Should only be set if you are using CPaaS X Applications with your traffic. - `resources` string[]: List of resources to match. At the moment, this could only be a sender name (whether numeric or alpha) used on message submit. - `users` string[]: List of users to match. You can provide usernames from your account. - `keywords` string[]: List of keywords to match. Route inbound messages by their first word. A customer texting STOP or ORDER to your number triggers only the subscriptions matching that keyword. - `profile` 6e71a232d29cf86cbe8cd24bd719c2050de4613347854f985c920dd3d0d3e33fProfileRequest, required: Notification profile object holding the settings for your webhook URL and a reference to security settings. You can provide full definition of a notification profile and security settings if you want to create new items, or provide an ID of an existing profile to reuse it. If you want to reuse an existing profile, do not provide any other notification profile and security settings properties. - `profileId` string, required: ID of a notification profile. This identifier will be used as part of a URL path and must not include any characters that require URL encoding. You cannot change the ID once an item is created. - `webhook` 6e71a232d29cf86cbe8cd24bd719c2050de4613347854f985c920dd3d0d3e33fWebhook: Webhook configuration. - `contentType` string - `notifyUrl` string, required: Your webhook URL, where the notifications will be sent to. - `security` 6e71a232d29cf86cbe8cd24bd719c2050de4613347854f985c920dd3d0d3e33fSecurityRequest: Security settings object holding the authentication settings necessary to access your webhook. Should only be provided if you are creating a new profile and settings; otherwise it will be ignored. - `authId` string, required: Unique security setting ID. Used as part of a URL path and must not include any characters that require URL encoding. You cannot change the ID once an item is created. - `type` 'BASIC' | 'HMAC' | 'OAUTH': Credentials type. - `credentials` union: Webhook security credentials. - object: Basic credentials. - `username` string, required: Username. - `password` string, required: Password. - object: HMAC credentials. - `secretKey` string, required: Secret key. - `algorithm` 'HMAC_MD5' | 'HMAC_SHA_1' | 'HMAC_SHA_224' | 'HMAC_SHA_256' | 'HMAC_SHA_384' | 'HMAC_SHA_512', required: HMAC algorithm. - object: OAuth credentials. - `tokenUrl` string, required: Token URL. - `clientId` string: Client ID. - `clientSecret` string: Client secret. - `grantType` string, required: Grant type. - `scope` string: Scope. - `username` string: Username. - `password` string: Password. - `resource` string: Resource. - `refreshToken` string: Refresh token. - `headers` object: Set of key:value pairs that will be sent in a HTTP request as headers. - `clientCertificateId` string: Client certificate ID. - `maxBucketSize` integer: Specifies a maximum number of messages to be sent within a single request. - `windowSize` integer: A maximum number of concurrent connections (active requests) per client. - `connectTimeout` integer: Time in milliseconds sender system waits for connection acknowledgement until the connection is closed. - `readTimeout` integer: A maximum period of inactivity in milliseconds between two consecutive data packets. - `enabledSSLProtocols` string[]: Specifies which security protocols should be used to send a HTTP request. Multiple options can be used. - `headers` object: Set of key:value pairs that will be sent in a HTTP request as headers.Note: 'Authorization' header (if configured here for any reason) can be overridden with one from security config. - `responseRegex` string: Response regex. - `responseBodyRegex` string: Response body regex. - `rateLimit` integer: Limits the number of requests per second. - 6e71a232d29cf86cbe8cd24bd719c2050de4613347854f985c920dd3d0d3e33fSmsSubscriptionRequest: Subscription group. - `subscriptionId` string, required: Subscription ID. Used as part of a URL path and must not include any characters that require URL encoding. You cannot change the ID once a subscription is created. - `name` string: A human-readable description for your subscription, can be changed at a later point. - `subscriptionGroupId` string: Subscription group identifier. Subscriptions with different group IDs for the same event will each receive the event independently, enabling multi-webhook delivery. - `events` union[], required: List of events available for a subscription. Note that a set of events available for each channel is different; subscription to events that are unavailable for a certain channel will be ignored. For more details, see the [availability table](https://www.infobip.com/docs/cpaas-x/subscriptions-management/event-subscriptions). If configuring inbound Subscription, check [inbound message configuration docs](https://www.infobip.com/docs/cpaas-x/subscriptions-management/inbound-message-configuration). - union - 'CLICK' | 'DELIVERY' | 'INBOUND_MESSAGE' - 6e71a232d29cf86cbe8cd24bd719c2050de4613347854f985c920dd3d0d3e33fFormatAwareSmsEvents - `event` 'CLICK' | 'DELIVERY' | 'INBOUND_MESSAGE', required - `format` string, required: Format which you want to assign to the event. For more information about available formats and their payload, check our [Event Formats](https://www.infobip.com/docs/cpaas-x/subscriptions-management/event-formats) page. - `criteria` 6e71a232d29cf86cbe8cd24bd719c2050de4613347854f985c920dd3d0d3e33fApplicationEntityPair[]: Application and Entity pair to match. You can set the rule to match only Application or only Entity if necessary, omitting the other item. - `applicationId` string: CPaaS X property identifying an application, an use case or an environment on your system. Should only be set if you are using CPaaS X Applications with your traffic. - `entityId` string: CPaaS X property identifying an unique actor on your system. Should only be set if you are using CPaaS X Applications with your traffic. - `callsConfigurationId` string: CPaaS X calls configuration identifier. Should only be set if you are using CPaaS X Applications with your traffic. - `resources` string[]: List of resources to match. At the moment, this could only be a sender name (whether numeric or alpha) used on message submit. - `users` string[]: List of users to match. You can provide usernames from your account. - `keywords` string[]: List of keywords to match. Route inbound messages by their first word. A customer texting STOP or ORDER to your number triggers only the subscriptions matching that keyword. - `profile` 6e71a232d29cf86cbe8cd24bd719c2050de4613347854f985c920dd3d0d3e33fProfileRequest, required: Notification profile object holding the settings for your webhook URL and a reference to security settings. You can provide full definition of a notification profile and security settings if you want to create new items, or provide an ID of an existing profile to reuse it. If you want to reuse an existing profile, do not provide any other notification profile and security settings properties. - `profileId` string, required: ID of a notification profile. This identifier will be used as part of a URL path and must not include any characters that require URL encoding. You cannot change the ID once an item is created. - `webhook` 6e71a232d29cf86cbe8cd24bd719c2050de4613347854f985c920dd3d0d3e33fWebhook: Webhook configuration. - `contentType` string - `notifyUrl` string, required: Your webhook URL, where the notifications will be sent to. - `security` 6e71a232d29cf86cbe8cd24bd719c2050de4613347854f985c920dd3d0d3e33fSecurityRequest: Security settings object holding the authentication settings necessary to access your webhook. Should only be provided if you are creating a new profile and settings; otherwise it will be ignored. - `authId` string, required: Unique security setting ID. Used as part of a URL path and must not include any characters that require URL encoding. You cannot change the ID once an item is created. - `type` 'BASIC' | 'HMAC' | 'OAUTH': Credentials type. - `credentials` union: Webhook security credentials. - object: Basic credentials. - `username` string, required: Username. - `password` string, required: Password. - object: HMAC credentials. - `secretKey` string, required: Secret key. - `algorithm` 'HMAC_MD5' | 'HMAC_SHA_1' | 'HMAC_SHA_224' | 'HMAC_SHA_256' | 'HMAC_SHA_384' | 'HMAC_SHA_512', required: HMAC algorithm. - object: OAuth credentials. - `tokenUrl` string, required: Token URL. - `clientId` string: Client ID. - `clientSecret` string: Client secret. - `grantType` string, required: Grant type. - `scope` string: Scope. - `username` string: Username. - `password` string: Password. - `resource` string: Resource. - `refreshToken` string: Refresh token. - `headers` object: Set of key:value pairs that will be sent in a HTTP request as headers. - `clientCertificateId` string: Client certificate ID. - `maxBucketSize` integer: Specifies a maximum number of messages to be sent within a single request. - `windowSize` integer: A maximum number of concurrent connections (active requests) per client. - `connectTimeout` integer: Time in milliseconds sender system waits for connection acknowledgement until the connection is closed. - `readTimeout` integer: A maximum period of inactivity in milliseconds between two consecutive data packets. - `enabledSSLProtocols` string[]: Specifies which security protocols should be used to send a HTTP request. Multiple options can be used. - `headers` object: Set of key:value pairs that will be sent in a HTTP request as headers.Note: 'Authorization' header (if configured here for any reason) can be overridden with one from security config. - `responseRegex` string: Response regex. - `responseBodyRegex` string: Response body regex. - `rateLimit` integer: Limits the number of requests per second. - 6e71a232d29cf86cbe8cd24bd719c2050de4613347854f985c920dd3d0d3e33fViberSubscriptionRequest: Subscription group. - `subscriptionId` string, required: Subscription ID. Used as part of a URL path and must not include any characters that require URL encoding. You cannot change the ID once a subscription is created. - `name` string: A human-readable description for your subscription, can be changed at a later point. - `subscriptionGroupId` string: Subscription group identifier. Subscriptions with different group IDs for the same event will each receive the event independently, enabling multi-webhook delivery. - `events` 6e71a232d29cf86cbe8cd24bd719c2050de4613347854f985c920dd3d0d3e33fSimpleViberEvents[], required: List of events available for a subscription. Note that a set of events available for each channel is different; subscription to events that are unavailable for a certain channel will be ignored. For more details, see the [availability table](https://www.infobip.com/docs/cpaas-x/subscriptions-management/event-subscriptions). If configuring inbound Subscription, check [inbound message configuration docs](https://www.infobip.com/docs/cpaas-x/subscriptions-management/inbound-message-configuration). - `criteria` 6e71a232d29cf86cbe8cd24bd719c2050de4613347854f985c920dd3d0d3e33fApplicationEntityPair[]: Application and Entity pair to match. You can set the rule to match only Application or only Entity if necessary, omitting the other item. - `applicationId` string: CPaaS X property identifying an application, an use case or an environment on your system. Should only be set if you are using CPaaS X Applications with your traffic. - `entityId` string: CPaaS X property identifying an unique actor on your system. Should only be set if you are using CPaaS X Applications with your traffic. - `callsConfigurationId` string: CPaaS X calls configuration identifier. Should only be set if you are using CPaaS X Applications with your traffic. - `resources` string[]: List of resources to match. At the moment, this could only be a sender name (whether numeric or alpha) used on message submit. - `users` string[]: List of users to match. You can provide usernames from your account. - `keywords` string[]: List of keywords to match. Route inbound messages by their first word. A customer texting STOP or ORDER to your number triggers only the subscriptions matching that keyword. - `profile` 6e71a232d29cf86cbe8cd24bd719c2050de4613347854f985c920dd3d0d3e33fProfileRequest, required: Notification profile object holding the settings for your webhook URL and a reference to security settings. You can provide full definition of a notification profile and security settings if you want to create new items, or provide an ID of an existing profile to reuse it. If you want to reuse an existing profile, do not provide any other notification profile and security settings properties. - `profileId` string, required: ID of a notification profile. This identifier will be used as part of a URL path and must not include any characters that require URL encoding. You cannot change the ID once an item is created. - `webhook` 6e71a232d29cf86cbe8cd24bd719c2050de4613347854f985c920dd3d0d3e33fWebhook: Webhook configuration. - `contentType` string - `notifyUrl` string, required: Your webhook URL, where the notifications will be sent to. - `security` 6e71a232d29cf86cbe8cd24bd719c2050de4613347854f985c920dd3d0d3e33fSecurityRequest: Security settings object holding the authentication settings necessary to access your webhook. Should only be provided if you are creating a new profile and settings; otherwise it will be ignored. - `authId` string, required: Unique security setting ID. Used as part of a URL path and must not include any characters that require URL encoding. You cannot change the ID once an item is created. - `type` 'BASIC' | 'HMAC' | 'OAUTH': Credentials type. - `credentials` union: Webhook security credentials. - object: Basic credentials. - `username` string, required: Username. - `password` string, required: Password. - object: HMAC credentials. - `secretKey` string, required: Secret key. - `algorithm` 'HMAC_MD5' | 'HMAC_SHA_1' | 'HMAC_SHA_224' | 'HMAC_SHA_256' | 'HMAC_SHA_384' | 'HMAC_SHA_512', required: HMAC algorithm. - object: OAuth credentials. - `tokenUrl` string, required: Token URL. - `clientId` string: Client ID. - `clientSecret` string: Client secret. - `grantType` string, required: Grant type. - `scope` string: Scope. - `username` string: Username. - `password` string: Password. - `resource` string: Resource. - `refreshToken` string: Refresh token. - `headers` object: Set of key:value pairs that will be sent in a HTTP request as headers. - `clientCertificateId` string: Client certificate ID. - `maxBucketSize` integer: Specifies a maximum number of messages to be sent within a single request. - `windowSize` integer: A maximum number of concurrent connections (active requests) per client. - `connectTimeout` integer: Time in milliseconds sender system waits for connection acknowledgement until the connection is closed. - `readTimeout` integer: A maximum period of inactivity in milliseconds between two consecutive data packets. - `enabledSSLProtocols` string[]: Specifies which security protocols should be used to send a HTTP request. Multiple options can be used. - `headers` object: Set of key:value pairs that will be sent in a HTTP request as headers.Note: 'Authorization' header (if configured here for any reason) can be overridden with one from security config. - `responseRegex` string: Response regex. - `responseBodyRegex` string: Response body regex. - `rateLimit` integer: Limits the number of requests per second. - 6e71a232d29cf86cbe8cd24bd719c2050de4613347854f985c920dd3d0d3e33fVoiceVideoSubscriptionRequest: Subscription group. - `subscriptionId` string, required: Subscription ID. Used as part of a URL path and must not include any characters that require URL encoding. You cannot change the ID once a subscription is created. - `name` string: A human-readable description for your subscription, can be changed at a later point. - `subscriptionGroupId` string: Subscription group identifier. Subscriptions with different group IDs for the same event will each receive the event independently, enabling multi-webhook delivery. - `events` 6e71a232d29cf86cbe8cd24bd719c2050de4613347854f985c920dd3d0d3e33fSimpleVoiceVideoEvents[], required: List of events available for a subscription. Note that a set of events available for each channel is different; subscription to events that are unavailable for a certain channel will be ignored. For more details, see the [availability table](https://www.infobip.com/docs/cpaas-x/subscriptions-management/event-subscriptions). If configuring inbound Subscription, check [inbound message configuration docs](https://www.infobip.com/docs/cpaas-x/subscriptions-management/inbound-message-configuration). - `criteria` 6e71a232d29cf86cbe8cd24bd719c2050de4613347854f985c920dd3d0d3e33fApplicationEntityPair[]: Application and Entity pair to match. You can set the rule to match only Application or only Entity if necessary, omitting the other item. - `applicationId` string: CPaaS X property identifying an application, an use case or an environment on your system. Should only be set if you are using CPaaS X Applications with your traffic. - `entityId` string: CPaaS X property identifying an unique actor on your system. Should only be set if you are using CPaaS X Applications with your traffic. - `callsConfigurationId` string: CPaaS X calls configuration identifier. Should only be set if you are using CPaaS X Applications with your traffic. - `resources` string[]: List of resources to match. At the moment, this could only be a sender name (whether numeric or alpha) used on message submit. - `users` string[]: List of users to match. You can provide usernames from your account. - `keywords` string[]: List of keywords to match. Route inbound messages by their first word. A customer texting STOP or ORDER to your number triggers only the subscriptions matching that keyword. - `profile` 6e71a232d29cf86cbe8cd24bd719c2050de4613347854f985c920dd3d0d3e33fProfileRequest, required: Notification profile object holding the settings for your webhook URL and a reference to security settings. You can provide full definition of a notification profile and security settings if you want to create new items, or provide an ID of an existing profile to reuse it. If you want to reuse an existing profile, do not provide any other notification profile and security settings properties. - `profileId` string, required: ID of a notification profile. This identifier will be used as part of a URL path and must not include any characters that require URL encoding. You cannot change the ID once an item is created. - `webhook` 6e71a232d29cf86cbe8cd24bd719c2050de4613347854f985c920dd3d0d3e33fWebhook: Webhook configuration. - `contentType` string - `notifyUrl` string, required: Your webhook URL, where the notifications will be sent to. - `security` 6e71a232d29cf86cbe8cd24bd719c2050de4613347854f985c920dd3d0d3e33fSecurityRequest: Security settings object holding the authentication settings necessary to access your webhook. Should only be provided if you are creating a new profile and settings; otherwise it will be ignored. - `authId` string, required: Unique security setting ID. Used as part of a URL path and must not include any characters that require URL encoding. You cannot change the ID once an item is created. - `type` 'BASIC' | 'HMAC' | 'OAUTH': Credentials type. - `credentials` union: Webhook security credentials. - object: Basic credentials. - `username` string, required: Username. - `password` string, required: Password. - object: HMAC credentials. - `secretKey` string, required: Secret key. - `algorithm` 'HMAC_MD5' | 'HMAC_SHA_1' | 'HMAC_SHA_224' | 'HMAC_SHA_256' | 'HMAC_SHA_384' | 'HMAC_SHA_512', required: HMAC algorithm. - object: OAuth credentials. - `tokenUrl` string, required: Token URL. - `clientId` string: Client ID. - `clientSecret` string: Client secret. - `grantType` string, required: Grant type. - `scope` string: Scope. - `username` string: Username. - `password` string: Password. - `resource` string: Resource. - `refreshToken` string: Refresh token. - `headers` object: Set of key:value pairs that will be sent in a HTTP request as headers. - `clientCertificateId` string: Client certificate ID. - `maxBucketSize` integer: Specifies a maximum number of messages to be sent within a single request. - `windowSize` integer: A maximum number of concurrent connections (active requests) per client. - `connectTimeout` integer: Time in milliseconds sender system waits for connection acknowledgement until the connection is closed. - `readTimeout` integer: A maximum period of inactivity in milliseconds between two consecutive data packets. - `enabledSSLProtocols` string[]: Specifies which security protocols should be used to send a HTTP request. Multiple options can be used. - `headers` object: Set of key:value pairs that will be sent in a HTTP request as headers.Note: 'Authorization' header (if configured here for any reason) can be overridden with one from security config. - `responseRegex` string: Response regex. - `responseBodyRegex` string: Response body regex. - `rateLimit` integer: Limits the number of requests per second. - 6e71a232d29cf86cbe8cd24bd719c2050de4613347854f985c920dd3d0d3e33fWebPushSubscriptionRequest: Subscription group. - `subscriptionId` string, required: Subscription ID. Used as part of a URL path and must not include any characters that require URL encoding. You cannot change the ID once a subscription is created. - `name` string: A human-readable description for your subscription, can be changed at a later point. - `subscriptionGroupId` string: Subscription group identifier. Subscriptions with different group IDs for the same event will each receive the event independently, enabling multi-webhook delivery. - `events` 6e71a232d29cf86cbe8cd24bd719c2050de4613347854f985c920dd3d0d3e33fSimpleWebPushEvents[], required: List of events available for a subscription. Note that a set of events available for each channel is different; subscription to events that are unavailable for a certain channel will be ignored. For more details, see the [availability table](https://www.infobip.com/docs/cpaas-x/subscriptions-management/event-subscriptions). If configuring inbound Subscription, check [inbound message configuration docs](https://www.infobip.com/docs/cpaas-x/subscriptions-management/inbound-message-configuration). - `criteria` 6e71a232d29cf86cbe8cd24bd719c2050de4613347854f985c920dd3d0d3e33fApplicationEntityPair[]: Application and Entity pair to match. You can set the rule to match only Application or only Entity if necessary, omitting the other item. - `applicationId` string: CPaaS X property identifying an application, an use case or an environment on your system. Should only be set if you are using CPaaS X Applications with your traffic. - `entityId` string: CPaaS X property identifying an unique actor on your system. Should only be set if you are using CPaaS X Applications with your traffic. - `callsConfigurationId` string: CPaaS X calls configuration identifier. Should only be set if you are using CPaaS X Applications with your traffic. - `resources` string[]: List of resources to match. At the moment, this could only be a sender name (whether numeric or alpha) used on message submit. - `users` string[]: List of users to match. You can provide usernames from your account. - `keywords` string[]: List of keywords to match. Route inbound messages by their first word. A customer texting STOP or ORDER to your number triggers only the subscriptions matching that keyword. - `profile` 6e71a232d29cf86cbe8cd24bd719c2050de4613347854f985c920dd3d0d3e33fProfileRequest, required: Notification profile object holding the settings for your webhook URL and a reference to security settings. You can provide full definition of a notification profile and security settings if you want to create new items, or provide an ID of an existing profile to reuse it. If you want to reuse an existing profile, do not provide any other notification profile and security settings properties. - `profileId` string, required: ID of a notification profile. This identifier will be used as part of a URL path and must not include any characters that require URL encoding. You cannot change the ID once an item is created. - `webhook` 6e71a232d29cf86cbe8cd24bd719c2050de4613347854f985c920dd3d0d3e33fWebhook: Webhook configuration. - `contentType` string - `notifyUrl` string, required: Your webhook URL, where the notifications will be sent to. - `security` 6e71a232d29cf86cbe8cd24bd719c2050de4613347854f985c920dd3d0d3e33fSecurityRequest: Security settings object holding the authentication settings necessary to access your webhook. Should only be provided if you are creating a new profile and settings; otherwise it will be ignored. - `authId` string, required: Unique security setting ID. Used as part of a URL path and must not include any characters that require URL encoding. You cannot change the ID once an item is created. - `type` 'BASIC' | 'HMAC' | 'OAUTH': Credentials type. - `credentials` union: Webhook security credentials. - object: Basic credentials. - `username` string, required: Username. - `password` string, required: Password. - object: HMAC credentials. - `secretKey` string, required: Secret key. - `algorithm` 'HMAC_MD5' | 'HMAC_SHA_1' | 'HMAC_SHA_224' | 'HMAC_SHA_256' | 'HMAC_SHA_384' | 'HMAC_SHA_512', required: HMAC algorithm. - object: OAuth credentials. - `tokenUrl` string, required: Token URL. - `clientId` string: Client ID. - `clientSecret` string: Client secret. - `grantType` string, required: Grant type. - `scope` string: Scope. - `username` string: Username. - `password` string: Password. - `resource` string: Resource. - `refreshToken` string: Refresh token. - `headers` object: Set of key:value pairs that will be sent in a HTTP request as headers. - `clientCertificateId` string: Client certificate ID. - `maxBucketSize` integer: Specifies a maximum number of messages to be sent within a single request. - `windowSize` integer: A maximum number of concurrent connections (active requests) per client. - `connectTimeout` integer: Time in milliseconds sender system waits for connection acknowledgement until the connection is closed. - `readTimeout` integer: A maximum period of inactivity in milliseconds between two consecutive data packets. - `enabledSSLProtocols` string[]: Specifies which security protocols should be used to send a HTTP request. Multiple options can be used. - `headers` object: Set of key:value pairs that will be sent in a HTTP request as headers.Note: 'Authorization' header (if configured here for any reason) can be overridden with one from security config. - `responseRegex` string: Response regex. - `responseBodyRegex` string: Response body regex. - `rateLimit` integer: Limits the number of requests per second. - 6e71a232d29cf86cbe8cd24bd719c2050de4613347854f985c920dd3d0d3e33fWhatsappSubscriptionRequest: Subscription group. - `subscriptionId` string, required: Subscription ID. Used as part of a URL path and must not include any characters that require URL encoding. You cannot change the ID once a subscription is created. - `name` string: A human-readable description for your subscription, can be changed at a later point. - `subscriptionGroupId` string: Subscription group identifier. Subscriptions with different group IDs for the same event will each receive the event independently, enabling multi-webhook delivery. - `events` 6e71a232d29cf86cbe8cd24bd719c2050de4613347854f985c920dd3d0d3e33fSimpleWhatsappEvents[], required: List of events available for a subscription. Note that a set of events available for each channel is different; subscription to events that are unavailable for a certain channel will be ignored. For more details, see the [availability table](https://www.infobip.com/docs/cpaas-x/subscriptions-management/event-subscriptions). If configuring inbound Subscription, check [inbound message configuration docs](https://www.infobip.com/docs/cpaas-x/subscriptions-management/inbound-message-configuration). - `criteria` 6e71a232d29cf86cbe8cd24bd719c2050de4613347854f985c920dd3d0d3e33fApplicationEntityPair[]: Application and Entity pair to match. You can set the rule to match only Application or only Entity if necessary, omitting the other item. - `applicationId` string: CPaaS X property identifying an application, an use case or an environment on your system. Should only be set if you are using CPaaS X Applications with your traffic. - `entityId` string: CPaaS X property identifying an unique actor on your system. Should only be set if you are using CPaaS X Applications with your traffic. - `callsConfigurationId` string: CPaaS X calls configuration identifier. Should only be set if you are using CPaaS X Applications with your traffic. - `resources` string[]: List of resources to match. At the moment, this could only be a sender name (whether numeric or alpha) used on message submit. - `users` string[]: List of users to match. You can provide usernames from your account. - `keywords` string[]: List of keywords to match. Route inbound messages by their first word. A customer texting STOP or ORDER to your number triggers only the subscriptions matching that keyword. - `profile` 6e71a232d29cf86cbe8cd24bd719c2050de4613347854f985c920dd3d0d3e33fProfileRequest, required: Notification profile object holding the settings for your webhook URL and a reference to security settings. You can provide full definition of a notification profile and security settings if you want to create new items, or provide an ID of an existing profile to reuse it. If you want to reuse an existing profile, do not provide any other notification profile and security settings properties. - `profileId` string, required: ID of a notification profile. This identifier will be used as part of a URL path and must not include any characters that require URL encoding. You cannot change the ID once an item is created. - `webhook` 6e71a232d29cf86cbe8cd24bd719c2050de4613347854f985c920dd3d0d3e33fWebhook: Webhook configuration. - `contentType` string - `notifyUrl` string, required: Your webhook URL, where the notifications will be sent to. - `security` 6e71a232d29cf86cbe8cd24bd719c2050de4613347854f985c920dd3d0d3e33fSecurityRequest: Security settings object holding the authentication settings necessary to access your webhook. Should only be provided if you are creating a new profile and settings; otherwise it will be ignored. - `authId` string, required: Unique security setting ID. Used as part of a URL path and must not include any characters that require URL encoding. You cannot change the ID once an item is created. - `type` 'BASIC' | 'HMAC' | 'OAUTH': Credentials type. - `credentials` union: Webhook security credentials. - object: Basic credentials. - `username` string, required: Username. - `password` string, required: Password. - object: HMAC credentials. - `secretKey` string, required: Secret key. - `algorithm` 'HMAC_MD5' | 'HMAC_SHA_1' | 'HMAC_SHA_224' | 'HMAC_SHA_256' | 'HMAC_SHA_384' | 'HMAC_SHA_512', required: HMAC algorithm. - object: OAuth credentials. - `tokenUrl` string, required: Token URL. - `clientId` string: Client ID. - `clientSecret` string: Client secret. - `grantType` string, required: Grant type. - `scope` string: Scope. - `username` string: Username. - `password` string: Password. - `resource` string: Resource. - `refreshToken` string: Refresh token. - `headers` object: Set of key:value pairs that will be sent in a HTTP request as headers. - `clientCertificateId` string: Client certificate ID. - `maxBucketSize` integer: Specifies a maximum number of messages to be sent within a single request. - `windowSize` integer: A maximum number of concurrent connections (active requests) per client. - `connectTimeout` integer: Time in milliseconds sender system waits for connection acknowledgement until the connection is closed. - `readTimeout` integer: A maximum period of inactivity in milliseconds between two consecutive data packets. - `enabledSSLProtocols` string[]: Specifies which security protocols should be used to send a HTTP request. Multiple options can be used. - `headers` object: Set of key:value pairs that will be sent in a HTTP request as headers.Note: 'Authorization' header (if configured here for any reason) can be overridden with one from security config. - `responseRegex` string: Response regex. - `responseBodyRegex` string: Response body regex. - `rateLimit` integer: Limits the number of requests per second. - 6e71a232d29cf86cbe8cd24bd719c2050de4613347854f985c920dd3d0d3e33fZaloSubscriptionRequest: Subscription group. - `subscriptionId` string, required: Subscription ID. Used as part of a URL path and must not include any characters that require URL encoding. You cannot change the ID once a subscription is created. - `name` string: A human-readable description for your subscription, can be changed at a later point. - `subscriptionGroupId` string: Subscription group identifier. Subscriptions with different group IDs for the same event will each receive the event independently, enabling multi-webhook delivery. - `events` 6e71a232d29cf86cbe8cd24bd719c2050de4613347854f985c920dd3d0d3e33fSimpleZaloEvents[], required: List of events available for a subscription. Note that a set of events available for each channel is different; subscription to events that are unavailable for a certain channel will be ignored. For more details, see the [availability table](https://www.infobip.com/docs/cpaas-x/subscriptions-management/event-subscriptions). If configuring inbound Subscription, check [inbound message configuration docs](https://www.infobip.com/docs/cpaas-x/subscriptions-management/inbound-message-configuration). - `criteria` 6e71a232d29cf86cbe8cd24bd719c2050de4613347854f985c920dd3d0d3e33fApplicationEntityPair[]: Application and Entity pair to match. You can set the rule to match only Application or only Entity if necessary, omitting the other item. - `applicationId` string: CPaaS X property identifying an application, an use case or an environment on your system. Should only be set if you are using CPaaS X Applications with your traffic. - `entityId` string: CPaaS X property identifying an unique actor on your system. Should only be set if you are using CPaaS X Applications with your traffic. - `callsConfigurationId` string: CPaaS X calls configuration identifier. Should only be set if you are using CPaaS X Applications with your traffic. - `resources` string[]: List of resources to match. At the moment, this could only be a sender name (whether numeric or alpha) used on message submit. - `users` string[]: List of users to match. You can provide usernames from your account. - `keywords` string[]: List of keywords to match. Route inbound messages by their first word. A customer texting STOP or ORDER to your number triggers only the subscriptions matching that keyword. - `profile` 6e71a232d29cf86cbe8cd24bd719c2050de4613347854f985c920dd3d0d3e33fProfileRequest, required: Notification profile object holding the settings for your webhook URL and a reference to security settings. You can provide full definition of a notification profile and security settings if you want to create new items, or provide an ID of an existing profile to reuse it. If you want to reuse an existing profile, do not provide any other notification profile and security settings properties. - `profileId` string, required: ID of a notification profile. This identifier will be used as part of a URL path and must not include any characters that require URL encoding. You cannot change the ID once an item is created. - `webhook` 6e71a232d29cf86cbe8cd24bd719c2050de4613347854f985c920dd3d0d3e33fWebhook: Webhook configuration. - `contentType` string - `notifyUrl` string, required: Your webhook URL, where the notifications will be sent to. - `security` 6e71a232d29cf86cbe8cd24bd719c2050de4613347854f985c920dd3d0d3e33fSecurityRequest: Security settings object holding the authentication settings necessary to access your webhook. Should only be provided if you are creating a new profile and settings; otherwise it will be ignored. - `authId` string, required: Unique security setting ID. Used as part of a URL path and must not include any characters that require URL encoding. You cannot change the ID once an item is created. - `type` 'BASIC' | 'HMAC' | 'OAUTH': Credentials type. - `credentials` union: Webhook security credentials. - object: Basic credentials. - `username` string, required: Username. - `password` string, required: Password. - object: HMAC credentials. - `secretKey` string, required: Secret key. - `algorithm` 'HMAC_MD5' | 'HMAC_SHA_1' | 'HMAC_SHA_224' | 'HMAC_SHA_256' | 'HMAC_SHA_384' | 'HMAC_SHA_512', required: HMAC algorithm. - object: OAuth credentials. - `tokenUrl` string, required: Token URL. - `clientId` string: Client ID. - `clientSecret` string: Client secret. - `grantType` string, required: Grant type. - `scope` string: Scope. - `username` string: Username. - `password` string: Password. - `resource` string: Resource. - `refreshToken` string: Refresh token. - `headers` object: Set of key:value pairs that will be sent in a HTTP request as headers. - `clientCertificateId` string: Client certificate ID. - `maxBucketSize` integer: Specifies a maximum number of messages to be sent within a single request. - `windowSize` integer: A maximum number of concurrent connections (active requests) per client. - `connectTimeout` integer: Time in milliseconds sender system waits for connection acknowledgement until the connection is closed. - `readTimeout` integer: A maximum period of inactivity in milliseconds between two consecutive data packets. - `enabledSSLProtocols` string[]: Specifies which security protocols should be used to send a HTTP request. Multiple options can be used. - `headers` object: Set of key:value pairs that will be sent in a HTTP request as headers.Note: 'Authorization' header (if configured here for any reason) can be overridden with one from security config. - `responseRegex` string: Response regex. - `responseBodyRegex` string: Response body regex. - `rateLimit` integer: Limits the number of requests per second. ## Response `201` Created. - 6e71a232d29cf86cbe8cd24bd719c2050de4613347854f985c920dd3d0d3e33fIdOnlySubscriptionResponse: Subscription group. - `subscriptionId` string: Subscription ID. - `profile` 6e71a232d29cf86cbe8cd24bd719c2050de4613347854f985c920dd3d0d3e33fIdOnlyProfileResponse: Notification profile. - `profileId` string: Unique profile ID. - `security` 6e71a232d29cf86cbe8cd24bd719c2050de4613347854f985c920dd3d0d3e33fIdOnlySecurityResponse: Security configuration. - `authId` string: Unique authorization ID. ## Other responses - `400`: Bad request. - `401`: Unauthorized - `403`: Forbidden - `404`: Not found. - `429`: Too many requests. - `500`: Internal Server Error --- [API](https://skmtc.dev/infobip/apis/infobip-openapi-specification.md) - [All operations](https://skmtc.dev/infobip/apis/infobip-openapi-specification/llms.txt) - [OpenAPI document](https://skmtc.dev/infobip/apis/infobip-openapi-specification/revisions/9dcbbaf902de?raw)