Documentation Index
Fetch the complete documentation index at: /llms.txt
Use this file to discover all available pages before exploring further.
curl --request PATCH \
--url https://api.nylon.dev/v1/webhooks/{webhookId} \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"events": [
"post.failed"
]
}
'{
"data": {
"id": "cly7w1a2b0001x8b3k9m2p0zz",
"url": "https://example.com/nylon/webhooks",
"events": [
"post.published"
],
"status": "active",
"secret_last_four": "8f2a",
"consecutive_failures": 0,
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z",
"description": "Production receiver",
"disabled_reason": "<string>",
"last_succeeded_at": "2023-11-07T05:31:56Z",
"last_failed_at": "2023-11-07T05:31:56Z"
}
}{
"error": {
"code": "invalid_request",
"message": "The request body is not valid.",
"details": [
{
"field": "profile_ids",
"message": "Address the post to at least one profile."
}
]
}
}{
"error": {
"code": "unauthorized",
"message": "A valid Nylon API key is required."
}
}{
"error": {
"code": "not_found",
"message": "Post could not be found."
}
}{
"error": {
"code": "rate_limited",
"message": "Too many requests. Retry after the window resets."
}
}{
"error": {
"code": "unauthorized",
"message": "A valid Nylon API key is required.",
"details": [
{
"message": "Instagram requires at least 1 media item — text-only posts are not supported.",
"field": "profile_ids",
"network": "instagram",
"code": "invalid_request"
}
]
}
}Change the URL, the subscriptions, or re-enable a disabled endpoint.
curl --request PATCH \
--url https://api.nylon.dev/v1/webhooks/{webhookId} \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"events": [
"post.failed"
]
}
'{
"data": {
"id": "cly7w1a2b0001x8b3k9m2p0zz",
"url": "https://example.com/nylon/webhooks",
"events": [
"post.published"
],
"status": "active",
"secret_last_four": "8f2a",
"consecutive_failures": 0,
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z",
"description": "Production receiver",
"disabled_reason": "<string>",
"last_succeeded_at": "2023-11-07T05:31:56Z",
"last_failed_at": "2023-11-07T05:31:56Z"
}
}{
"error": {
"code": "invalid_request",
"message": "The request body is not valid.",
"details": [
{
"field": "profile_ids",
"message": "Address the post to at least one profile."
}
]
}
}{
"error": {
"code": "unauthorized",
"message": "A valid Nylon API key is required."
}
}{
"error": {
"code": "not_found",
"message": "Post could not be found."
}
}{
"error": {
"code": "rate_limited",
"message": "Too many requests. Retry after the window resets."
}
}{
"error": {
"code": "unauthorized",
"message": "A valid Nylon API key is required.",
"details": [
{
"message": "Instagram requires at least 1 media item — text-only posts are not supported.",
"field": "profile_ids",
"network": "instagram",
"code": "invalid_request"
}
]
}
}An API key beginning with nylon_live_.
The Nylon id of the webhook endpoint.
"cly7w1a2b0001x8b3k9m2p0zz"
Every field is optional. Sending events replaces the subscription list.
The updated endpoint.
Hide child attributes
"cly7w1a2b0001x8b3k9m2p0zz"
"https://example.com/nylon/webhooks"
Subscribed events. An empty array means every event.
post.published, post.partially_published, post.failed, profile.connected, profile.disconnected, profile.needs_attention Nylon disables an endpoint after 20 consecutive failed deliveries.
active, disabled The last four characters of the signing secret, to tell two secrets apart.
"8f2a"
Failed deliveries since the last success. Any success resets it to zero.
0
"Production receiver"