Skip to main content
POST
Create security settings

Authorizations

Authorization
string
header
default:App
required

This is the most secure authorization type and the one with the most flexibility.

API keys can be generated by calling the dedicated API method. Furthermore, API keys can have a limited scope and cover only some API methods. Lastly, they can be revoked at any time. This range of possibilities makes API keys well suited for separating the API access rights across multiple applications or use cases. Finally, the loss of an API key is easily manageable.

You can manage your API keys from GUI, or programmatically with dedicated API.

API key Authorization header example:

Body

application/json

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.

Required string length: 1 - 255
type
enum<string>

Credentials type.

Available options:
BASIC,
HMAC,
OAUTH,
CUSTOM
credentials
BasicCredentials · object

Basic credentials.

Response

Created.

Security configuration.

authId
string

Unique authorization ID.