Documentation

Learn how to integrate Dplyd with your deployment workflow

Authentication

All API requests require authentication using a token. You can generate a token from your profile page.

curl -H "Authorization: Bearer YOUR_API_TOKEN" https://dplyd.com/api

Endpoints

Create a Deployment

POST /api

Create a new deployment announcement.

Request Body

{
  "message": "Deployed v1.2.3 with new user dashboard",
  "url": "https://example.com" // Optional
}

Examples

JSON format:

curl -X POST \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer YOUR_API_TOKEN" \
  -d '{"message": "Deployed v1.2.3", "url": "https://example.com"}' \
  https://dplyd.com/api

Form-encoded format:

curl -X POST \
  -H "Authorization: Bearer YOUR_API_TOKEN" \
  -d 'message=Deployed%20v1.2.3&url=https%3A%2F%2Fexample.com' \
  https://dplyd.com/api

Response

{
  "id": 123,
  "message": "Deployed v1.2.3 with new user dashboard",
  "url": "https://example.com",
  "deployed_at": "2025-04-06T09:30:00Z",
  "user": {
    "id": 42,
    "name": "Jane Smith"
  },
  "status": "success"
}

Error Responses

Authentication Error

{
  "error": "Unauthorized",
  "message": "Invalid or missing API token"
}

Validation Error

{
  "error": "Validation Error",
  "message": "Validation failed",
  "details": {
    "message": ["can't be blank"]
  }
}

Resource Not Found

{
  "error": "Not Found",
  "message": "The requested resource could not be found"
}