curl --request POST \
--url https://api.nylon.dev/v1/webhooks \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"url": "https://example.com/nylon/webhooks"
}
'
{
"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",
"secret": "whsec_9tK2mQ7pR4wX1bN6vC3zL8yF",
"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": "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"
}
]
}
}{
"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"
}
]
}
}Webhooks
Register a webhook endpoint
Register an endpoint and get its signing secret, once.
POST
https://api.nylon.dev
/
v1
/
webhooks
curl --request POST \
--url https://api.nylon.dev/v1/webhooks \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"url": "https://example.com/nylon/webhooks"
}
'
{
"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",
"secret": "whsec_9tK2mQ7pR4wX1bN6vC3zL8yF",
"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": "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"
}
]
}
}{
"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"
}
]
}
}Authorizations
An API key beginning with nylon_live_.
Body
application/json
An https URL. Private and link-local addresses are refused.
Maximum string length:
200Events to subscribe to. Omit for every event.
Available options:
post.published, post.partially_published, post.failed, profile.connected, profile.disconnected, profile.needs_attention Response
The endpoint, including its signing secret.
Hide child attributes
Hide child attributes
Example:
"cly7w1a2b0001x8b3k9m2p0zz"
Example:
"https://example.com/nylon/webhooks"
Subscribed events. An empty array means every event.
Available options:
post.published, post.partially_published, post.failed, profile.connected, profile.disconnected, profile.needs_attention Nylon disables an endpoint after 20 consecutive failed deliveries.
Available options:
active, disabled The last four characters of the signing secret, to tell two secrets apart.
Example:
"8f2a"
Failed deliveries since the last success. Any success resets it to zero.
Example:
0
The signing secret, returned by creation and rotation only. Store it now — it is not readable afterwards.
Example:
"whsec_9tK2mQ7pR4wX1bN6vC3zL8yF"
Example:
"Production receiver"
⌘I