Create webhook
Creates a developer webhook subscription for your workspace. You can provide your own signing secret or let UniPost generate one and return it exactly once in this response.
Authorization
AuthorizationBearer <token>In header
Workspace API key.
Request Body
namestring
Human-readable label for this webhook subscription.
urlstring
HTTPS endpoint that should receive UniPost events. Leading and trailing whitespace is trimmed.
eventsstring[]
Event names to subscribe to.
Valuespost.published | post.partial | post.failed | account.connected | account.disconnected
active?boolean
Whether delivery should start immediately. Defaults to true.
secret?string
Optional custom HMAC signing secret. If omitted, UniPost generates one and returns it once.
Response Body
201
idstring
Webhook subscription ID.
namestring
Human-readable webhook label.
urlstring
Stored destination URL.
eventsstring[]
Subscribed event names.
Valuespost.published | post.partial | post.failed | account.connected | account.disconnected
activeboolean
Whether this subscription is currently enabled.
secretstring
Plaintext signing secret. Returned only once at creation time.
secret_previewstring
Short prefix shown on later reads so humans can identify the secret.
created_atstring
Creation timestamp.
401
error.codestring
Validation errors use "VALIDATION_ERROR"; auth errors use "UNAUTHORIZED".
error.normalized_codestring
Lowercase alias such as "validation_error" or "unauthorized".
error.messagestring
Human-readable error message.
request_idstring
Request identifier for debugging and support.
422
error.codestring
Validation errors use "VALIDATION_ERROR"; auth errors use "UNAUTHORIZED".
error.normalized_codestring
Lowercase alias such as "validation_error" or "unauthorized".
error.messagestring
Human-readable error message.
request_idstring
Request identifier for debugging and support.
500
error.codestring
Validation errors use "VALIDATION_ERROR"; auth errors use "UNAUTHORIZED".
error.normalized_codestring
Lowercase alias such as "validation_error" or "unauthorized".
error.messagestring
Human-readable error message.
request_idstring
Request identifier for debugging and support.