Skip to main content
POST

Create Webhook

Creates an endpoint. The response returns the full signing secret, so store it now. The API never returns it again; you can see it again or rotate it in the app under Settings → Agents & Integrations → Webhooks.

Request

integer
required
The workspace the endpoint belongs to
string
required
Display name of the endpoint
string
required
A public https address. Private and reserved addresses are refused.
array
required
Event keys the endpoint gets, such as post.failed. See Webhooks for the list.
array
Only send events about these social accounts. Leave out for all accounts.
array
Also send events from these workspaces, or ["*"] for every workspace you own. You must be an owner or manager of each one, and only the workspace owner can use "*".

Response

Status 201. The endpoint object, plus:
string
The signing secret in full, starting with whsec_. The API returns it only in this response.
integer
Unique identifier of the endpoint
string
Display name of the endpoint
string
The https address that receives the events. An address can carry a token, so it is shown in full only when the key’s owner may edit the endpoint (notifications edit in its workspace, and in every workspace it covers). Otherwise it is cut to the scheme and host, such as https://example.com/….
boolean
true when url was cut because the key’s owner may not edit the endpoint
string
The last four characters of the signing secret. The API returns the full secret only when you create the endpoint; the app can show it again.
array
Event keys the endpoint gets
array
Social account ids the endpoint is limited to, or null for all accounts
array
Other workspaces whose events it also gets (["*"] for every workspace the creator owns), or null
boolean
Whether the endpoint is on. PostSyncer turns an endpoint off after it has been failing for 3 days.
string
When the endpoint started failing, or null
string
Why PostSyncer turned the endpoint off, or null
object
Deliveries over the last 7 days: sent, failed and daily, seven entries with the oldest first
string
When the latest delivery was made, or null

Errors

Code Examples