Skip to main content
POST
Add a new domain to your HookPulse account with rate limiting and concurrency control settings.

Example request

Request body

Example response

Response fields

Authorizations

x-hookpulse-api-key
string
header
required

API key for authentication. Get this from your dashboard by selecting a brand and going to API Keys section.

x-brand-uuid
string
header
required

Brand UUID for authentication. Get this from your dashboard after adding a brand - it will be displayed in the UI.

Body

application/json

Domain configuration

protocol_type
string
required

Protocol type for the domain (e.g., 'https', 'http')

domain
string
required

Domain name to add

rate_limit_enabled
boolean
required

Enable rate limiting for this domain

concurrency_control_enabled
boolean
required

Enable concurrency control for this domain

max_concurrent_jobs
integer
required

Maximum number of concurrent jobs allowed

max_requests_per_second
integer
required

Maximum requests per second allowed

Response

Domain added successfully

success
boolean

Indicates if the request was successful

details
string

Success message or error details