Skip to main content
POST
Create an endpoint

Authorizations

X-Auth-Token
string
header
required

FlowPayroll JWT (raw token, no Bearer prefix)

Headers

Idempotency-Key
string

Makes a retry safe: the same key from the same person with the same body within 24 hours gets the first response back instead of running again. The same key with a different request is refused with 409.

Maximum string length: 255

Query Parameters

scope
enum<string>
default:organisation

Whose resources: your organisation's (the default), or with account-wide access the account's (customer).

Available options:
organisation,
customer

Body

application/json
url
string
required
eventTypes
string[]
required
description
null | string
payloadStyle
null | enum<string>
Available options:
Minimal,
Full,
null
ordering
null | enum<string>
Available options:
Unordered,
Fifo,
null
rateLimitPerSecond
null | integer<int32>
organisationIds
null | string[]
excludedOrganisationIds
null | string[]
customHeaders
null | object
alertContacts
null | string[]

Response

Created

message
object
content
object
validationIssues
null | object[]