Your First Warp with Webhook

Types of HTTP Integrations:

1. Webhooks (Push notifications)
   - Receive real-time data from services
   - Example: GitHub push events

2. REST APIs (Request/Response)
   - Send data to external services
   - Example: Creating a task in a project management tool

3. Custom Endpoints
   - Your own application endpoints
   - Example: Internal business logic triggers

Endpoint Information to Gather:

- Full URL: https://api.example.com/v1/tasks
- HTTP Method: POST, GET, PUT, DELETE
- Required Headers: Authorization, Content-Type
- Request Body Format: JSON, XML, Form Data
- Expected Response: Status codes, response format
- Rate Limits: Requests per minute/hour
- Authentication: API key, Bearer token, Basic auth

# Example API test with curl
curl -X POST \
  "https://api.example.com/v1/tasks" \
  -H "Authorization: Bearer your-api-token" \
  -H "Content-Type: application/json" \
  -d '{
    "title": "Test Task from WarpTrigger",
    "description": "This is a test task",
    "priority": "high",
    "due_date": "2024-03-15"
  }'

Common HTTP Status Codes:

✅ Success Codes:
- 200 OK: Request successful
- 201 Created: Resource created successfully
- 204 No Content: Success with no response body

⚠️ Client Error Codes:
- 400 Bad Request: Invalid request format
- 401 Unauthorized: Authentication required
- 403 Forbidden: Access denied
- 404 Not Found: Endpoint doesn't exist
- 429 Too Many Requests: Rate limit exceeded

🚨 Server Error Codes:
- 500 Internal Server Error: Server-side issue
- 502 Bad Gateway: Upstream server error
- 503 Service Unavailable: Temporary outage

Integration Planning Questions:

1. What data needs to be sent?
2. How often should requests be made?
3. What should happen if the endpoint fails?
4. Do you need to process the response?
5. Are there dependencies between requests?
6. What authentication is required?
7. Are there rate limits to consider?

Warp Name: Daily Task Creation API Call

every weekday at 9:00 AM EST

URL: https://api.example.com/v1/tasks
Method: POST

Common Method Usage:
- GET: Retrieve data or trigger read-only actions
- POST: Create new resources or send data
- PUT: Update existing resources completely
- PATCH: Partially update existing resources
- DELETE: Remove resources

Required Headers:
Authorization: Bearer your-api-token
Content-Type: application/json
Accept: application/json
User-Agent: WarpTrigger/1.0

Optional Headers:
X-API-Version: v1
X-Request-ID: {{unique_id}}
X-Source: warptrigger-automation

{
  "title": "Daily Standup Reminder",
  "description": "Automated reminder for team standup meeting",
  "assignee": {
    "email": "[email protected]",
    "name": "Team Lead"
  },
  "priority": "medium",
  "tags": ["automation", "standup", "reminder"],
  "due_date": "{{current_date}}",
  "metadata": {
    "source": "warptrigger",
    "automation_id": "daily-standup-reminder",
    "created_at": "{{timestamp}}"
  }
}

Dynamic Variables in Payloads:

{
  "event_name": "Weekly Report Generation",
  "scheduled_time": "{{current_timestamp}}",
  "report_period": {
    "start_date": "{{last_monday}}",
    "end_date": "{{current_date}}"
  },
  "recipients": [
    {
      "email": "[email protected]",
      "role": "manager"
    }
  ],
  "report_id": "weekly-{{year}}-{{week_number}}"
}

Authentication Methods:

1. API Key in Header:
   X-API-Key: your-secret-key

2. Bearer Token:
   Authorization: Bearer eyJhbGciOiJIUzI1NiIs...

3. Basic Authentication:
   Authorization: Basic base64(username:password)

4. OAuth 2.0:
   Authorization: Bearer oauth-access-token

5. Custom Authentication:
   X-Auth-Token: custom-token
   X-Auth-Signature: hmac-signature

Multi-Step Workflow Example:

Step 1: GET user data
  → https://api.example.com/users/123

Step 2: POST create project (use user data)
  → https://api.example.com/projects

Step 3: PUT update user with project ID
  → https://api.example.com/users/123

Step 4: POST send notification
  → https://api.notifications.com/send

Content Type Examples:

1. JSON (most common):
Content-Type: application/json
{"key": "value"}

2. Form Data:
Content-Type: application/x-www-form-urlencoded
key1=value1&key2=value2

3. XML:
Content-Type: application/xml
<?xml version="1.0"?><data><key>value</key></data>

4. Plain Text:
Content-Type: text/plain
Simple text content

5. Multipart Form:
Content-Type: multipart/form-data
(for file uploads)

{
  "request_config": {
    "url": "{{base_url}}/{{endpoint_type}}",
    "method": "{{http_method}}",
    "payload": {
      "message": "{{message_content}}",
      "priority": "{{priority_level}}",
      "environment": "{{deployment_env}}"
    }
  },
  "conditions": {
    "if_weekend": {
      "priority": "low",
      "endpoint_type": "background-tasks"
    },
    "if_business_hours": {
      "priority": "high",
      "endpoint_type": "immediate-tasks"
    }
  }
}

Error Handling Strategy:

1. Immediate Retry (network errors):
   - Retry 3 times with 1-second intervals

2. Rate Limit Handling (429 errors):
   - Wait for Retry-After header duration
   - Implement exponential backoff

3. Server Errors (5xx):
   - Retry with exponential backoff
   - Maximum 5 attempts

4. Client Errors (4xx):
   - Log error for investigation
   - Don't retry (fix required)

5. Fallback Actions:
   - Send to alternate endpoint
   - Log to monitoring system
   - Send alert notification

# Typical API Response Processing
{
  "response_handling": {
    "success_indicators": ["200", "201", "204"],
    "extract_data": {
      "task_id": "response.data.id",
      "creation_time": "response.data.created_at",
      "status": "response.data.status"
    },
    "next_actions": {
      "if_success": "log_completion",
      "if_error": "send_alert",
      "store_response": true
    }
  }
}

# Example response data usage
{
  "follow_up_request": {
    "url": "https://api.example.com/tasks/{{task_id}}/status",
    "schedule": "in 5 minutes"
  }
}

Testing Checklist:

✅ Successful request scenarios
✅ Authentication failures
✅ Network timeout handling
✅ Invalid payload formats
✅ Rate limit responses
✅ Server error responses
✅ Large payload handling
✅ Special character encoding
✅ Timezone handling
✅ Variable substitution

Monitoring Metrics:

Success Metrics:
- Response time (< 5 seconds ideal)
- Success rate (> 99% target)
- Requests per minute

Error Metrics:
- HTTP error rate by status code
- Network timeout frequency
- Authentication failure rate

Performance Metrics:
- Average response time
- Peak request volume
- Retry attempt frequency

{
  "logging_config": {
    "log_requests": true,
    "log_responses": true,
    "log_headers": false,
    "log_body": true,
    "include_timing": true,
    "redact_sensitive": ["authorization", "x-api-key"]
  },
  "debug_info": {
    "request_id": "{{unique_id}}",
    "timestamp": "{{iso_timestamp}}",
    "warp_name": "{{warp_name}}",
    "target_url": "{{endpoint_url}}"
  }
}

Rate Limit Strategies:

1. Understand Limits:
   - Read API documentation
   - Monitor rate limit headers
   - Track usage patterns

2. Implement Backoff:
   - Exponential backoff on 429 errors
   - Respect Retry-After headers
   - Queue requests when near limits

3. Distribute Load:
   - Spread requests across time
   - Use multiple API keys if allowed
   - Batch operations when possible

4. Monitor Usage:
   - Track requests per time period
   - Alert before hitting limits
   - Adjust schedules based on usage

{
  "health_check": {
    "endpoint": "https://api.example.com/health",
    "method": "GET",
    "expected_status": 200,
    "expected_response": {"status": "ok"},
    "timeout": 10,
    "frequency": "every 5 minutes"
  },
  "alert_conditions": {
    "consecutive_failures": 3,
    "response_time_threshold": 30,
    "error_rate_threshold": 0.05
  },
  "notification_channels": [
    {"type": "email", "to": "[email protected]"},
    {"type": "slack", "channel": "#alerts"}
  ]
}

Documentation Template:

Integration: [Service Name]
Endpoint: [URL]
Purpose: [What it does]
Schedule: [When it runs]
Payload: [Data structure]
Authentication: [How to authenticate]
Error Handling: [What happens on failure]
Dependencies: [Other systems involved]
Contacts: [Who to contact for issues]
Last Updated: [Date]

Troubleshooting:
- Common errors and solutions
- Rate limit information
- Service status page URLs
- Emergency procedures