Subscribe an endpoint
Register an endpoint to receive Airbyte sync notifications. Requires an agency key (ak_).
The URL is treated as opaque and stored as a secret: pass your own authentication inside it (a query-string token is the usual shape, since Airbyte's own notifications are unsigned) and it will be encrypted at rest. Must be https.
Idempotent on the URL. Re-posting a URL that already exists updates its label and clears its failure state rather than creating a second subscription — a duplicate would deliver every notification twice. Re-posting is also how you resume a subscription that was parked after repeated delivery failures.
Delivery is best-effort and unordered. The event is already durable in /sync-events, so there is no redelivery queue here; dedupe on job_id and order on finished_at, never on delivered_at or your own receipt time. A retried older failure CAN arrive after a newer success.
curl -X POST "https://mythic-analytics.gulp.workers.dev/client/v1/airbyte/webhooks" \
-H "Content-Type: application/json" \
-H "Authorization: Bearer YOUR_API_TOKEN" \
-H "Authorization: Bearer YOUR_API_TOKEN" \
-d '{
"url": "https://example.com/hooks/airbyte?secret=REPLACE_ME",
"label": "example_string"
}'
import requests
import json
url = "https://mythic-analytics.gulp.workers.dev/client/v1/airbyte/webhooks"
headers = {
"Content-Type": "application/json",
"Authorization": "Bearer YOUR_API_TOKEN"
}
data = {
"url": "https://example.com/hooks/airbyte?secret=REPLACE_ME",
"label": "example_string"
}
response = requests.post(url, headers=headers, json=data)
print(response.json())
const response = await fetch("https://mythic-analytics.gulp.workers.dev/client/v1/airbyte/webhooks", {
method: "POST",
headers: {
"Content-Type": "application/json",
"Authorization": "Bearer YOUR_API_TOKEN"
},
body: JSON.stringify({
"url": "https://example.com/hooks/airbyte?secret=REPLACE_ME",
"label": "example_string"
})
});
const data = await response.json();
console.log(data);
package main
import (
"fmt"
"net/http"
"bytes"
"encoding/json"
)
func main() {
data := []byte(`{
"url": "https://example.com/hooks/airbyte?secret=REPLACE_ME",
"label": "example_string"
}`)
req, err := http.NewRequest("POST", "https://mythic-analytics.gulp.workers.dev/client/v1/airbyte/webhooks", bytes.NewBuffer(data))
if err != nil {
panic(err)
}
req.Header.Set("Content-Type", "application/json")
req.Header.Set("Authorization", "Bearer YOUR_API_TOKEN")
req.Header.Set("Authorization", "Bearer YOUR_API_TOKEN")
client := &http.Client{}
resp, err := client.Do(req)
if err != nil {
panic(err)
}
defer resp.Body.Close()
fmt.Println("Response Status:", resp.Status)
}
require 'net/http'
require 'json'
uri = URI('https://mythic-analytics.gulp.workers.dev/client/v1/airbyte/webhooks')
http = Net::HTTP.new(uri.host, uri.port)
http.use_ssl = true
request = Net::HTTP::Post.new(uri)
request['Content-Type'] = 'application/json'
request['Authorization'] = 'Bearer YOUR_API_TOKEN'
request['Authorization'] = 'Bearer YOUR_API_TOKEN'
request.body = '{
"url": "https://example.com/hooks/airbyte?secret=REPLACE_ME",
"label": "example_string"
}'
response = http.request(request)
puts response.body
{
"success": true,
"data": {
"id": "123e4567-e89b-12d3-a456-426614174000",
"label": "example_string",
"url": "https://example.com/hooks/airbyte?secret=***",
"active": true,
"last_delivery_at": "2024-12-25T10:00:00Z",
"last_error": "example_string",
"consecutive_failures": 42,
"created_at": "2024-12-25T10:00:00Z"
}
}
{
"error": "Bad Request",
"message": "The request contains invalid parameters or malformed data",
"code": 400,
"details": [
{
"field": "email",
"message": "Invalid email format"
}
]
}
{
"error": "Unauthorized",
"message": "Authentication required. Please provide a valid API token",
"code": 401
}
{
"error": "Forbidden",
"message": "You don't have permission to access this resource",
"code": 403
}
/webhooks
Target server for requests. Edit to use your own host.
Agency key as bearer token, format Bearer ak_.... Grants full read-write access scoped to the agency. Agency-wide scoped keys (mcp_ with no fixed location) are accepted too and need airbyte:read or airbyte:write; a client-bound mcp_ key gets 403 agency_key_required. See Using an mcp_ key over HTTP.
Bearer ak_.... Grants full read-write access scoped to the agency. Agency-wide scoped keys (mcp_ with no fixed location) are accepted too and need airbyte:read or airbyte:write; a client-bound mcp_ key gets 403 agency_key_required. See Using an mcp_ key over HTTP.
Location secret key as bearer token, format Bearer sk_.... Grants read-only access; the agency is resolved from the location. Write endpoints return 403.
Bearer sk_.... Grants read-only access; the agency is resolved from the location. Write endpoints return 403.
The media type of the request body
HTTPS endpoint to POST notifications to. Stored encrypted; returned redacted.
Your own name for this endpoint, shown when listing subscriptions.
Request Preview
Response
Response will appear here after sending the request
Authentication
Bearer token. Agency key as bearer token, format Bearer ak_.... Grants full read-write access scoped to the agency. Agency-wide scoped keys (mcp_ with no fixed location) are accepted too and need airbyte:read or airbyte:write; a client-bound mcp_ key gets 403 agency_key_required. See Using an mcp_ key over HTTP.
Bearer token. Location secret key as bearer token, format Bearer sk_.... Grants read-only access; the agency is resolved from the location. Write endpoints return 403.
Body
HTTPS endpoint to POST notifications to. Stored encrypted; returned redacted.
https://example.com/hooks/airbyte?secret=REPLACE_MEYour own name for this endpoint, shown when listing subscriptions.