API v2 - Posts
Incoming webhook to create posts (v2)

Returns a list of all posts in the system. Requires valid authentication token.

Authentication¶ ↑

All authentication strategies are supported:

• JWT Token: Standard JWT with HS256 algorithm

• Database Token: Custom token stored in user record

• API Key: 40-character alphanumeric key

• Devise Token Auth: Requires uid and client headers

Errors

Examples

curl -X GET https://your-domain.com/api/v2/posts \
  -H "Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9..." \
  -H "Content-Type: application/json"
  
Response (200):
[
  {
    "id": 1,
    "title": "Sample Post Title",
    "content": "This is the content of the post...",
    "author_id": 123,
    "created_at": "2024-01-15T10:30:00Z",
    "updated_at": "2024-01-15T10:30:00Z"
  },
  {
    "id": 2,
    "title": "Another Post",
    "content": "Another post content...",
    "author_id": 456,
    "created_at": "2024-01-16T14:20:00Z",
    "updated_at": "2024-01-16T14:20:00Z"
  }
]

Error Response (401):
{
  "error": "Unauthorized"
}

Headers

Returns a single post by its ID. Requires valid authentication token.

Authentication¶ ↑

All authentication strategies are supported:

• JWT Token: Standard JWT with HS256 algorithm

• Database Token: Custom token stored in user record

• API Key: 40-character alphanumeric key

• Devise Token Auth: Requires uid and client headers

Errors

Examples

curl -X GET https://your-domain.com/api/v2/posts/123       -H "Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9..."       -H "Content-Type: application/json"

Response (200):
{
  "id": 123,
  "title": "Sample Post Title",
  "content": "This is the content of the post...",
  "author_id": 456,
  "created_at": "2024-01-15T10:30:00Z",
  "updated_at": "2024-01-16T14:20:00Z"
}

Error Response (404):
{
  "error": "Not Found"
}

Params

Headers

Search and filter posts using Ransack gem query parameters. Returns filtered results based on the provided search criteria.

Ransack Predicates¶ ↑

Common predicates you can use:

• _eq: Equal to

• _cont: Contains (case insensitive)

• _start: Starts with

• _end: Ends with

• _gt: Greater than

• _gteq: Greater than or equal to

• _lt: Less than

• _lteq: Less than or equal to

• _in: In array

• _null: Is null

• _not_null: Is not null

Sorting¶ ↑

Use q parameter for sorting:

• q=created_at desc

• q=title asc

• q=author_id desc

Examples¶ ↑

• Search by title: ?q=rails

• Search by author: ?q=123

• Date range: ?q=2024-01-01&q=2024-12-31

• Multiple authors: ?q[]=1&q[]=2

Errors

Examples

# Simple title search
curl -X GET "https://your-domain.com/api/v2/posts/search?q[title_cont]=rails" \
  -H "Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9..." \
  -H "Content-Type: application/json"

# Complex search with multiple filters
curl -X GET "https://your-domain.com/api/v2/posts/search?q[title_cont]=guide&q[author_id_eq]=123&q[created_at_gteq]=2024-01-01&q[s]=created_at%20desc" \
  -H "Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9..." \
  -H "Content-Type: application/json"

# Search multiple authors
curl -X GET "https://your-domain.com/api/v2/posts/search?q[author_id_in][]=1&q[author_id_in][]=2&q[s]=title%20asc" \
  -H "Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9..." \
  -H "Content-Type: application/json"

Success Response (200):
[
  {
    "id": 1,
    "title": "Rails Guide",
    "content": "A comprehensive rails guide...",
    "author_id": 123,
    "created_at": "2024-01-15T10:30:00Z",
    "updated_at": "2024-01-15T10:30:00Z"
  }
]

Empty Results (200):
[]

Error Response (401):
{
  "error": "Unauthorized"
}

Params

Headers

Errors

Examples

Request:
  POST /api/v2/webhooks/posts
  Headers: { "X-Webhook-Secret": "<secret>" }
  Body:
  {
    "title": "Example from Webhook",
    "content": "Hello from an external system",
    "post_type": "idea",
    "user_id": 1,
    "tags": ["integration", "external"]
  }

Success (201):
  { "id": 42, "url": "https://needpedia.org/posts/42" }

Params

Headers