Get a webhook
Returns a webhook and its maker, with its secret redacted. The local command can read any subscription; keys and apps can read only their own.
bearerAuthAuthorizationBearer <token>Authenticate with an API key (marfa_k1_…) or an OAuth access token (marfa_at_…).
id*stringThe ID of the webhook.
Returns the webhook.
application/json- response
A webhook sends the events you choose, as you can read them, to a URL.
id*stringUnique identifier for the webhook.
url*stringThe URL Marfa posts events to.
events*array<string>The events Marfa sends, such as item.created.
type_filter*|The type, with its subtypes, or the pattern whose item events Marfa sends. null when Marfa sends item events of every type. Edge events aren't filtered.
secret*stringThe key Marfa signs each delivery with. Only POST /webhooks returns it whole; other responses show **** and its last four characters.
active*booleantrue if Marfa sends events to the webhook.
created_at*stringWhen the webhook was created, in UTC.
updated_at*stringWhen the webhook last changed, in UTC.
maker*The credential that registered this webhook.
validation_error: the query has a parameter this endpoint doesn't take.
application/json- response
An error response.
error*What went wrong.
unauthorized: the request has no credential, or its credential is not valid. For a key that has expired, details.expired_at says when it expired.
application/json- response
An error response.
error*What went wrong.
forbidden: you don't havewebhooks.manage.
application/json- response
An error response.
error*What went wrong.
webhook_not_found: no webhook of yours has this ID.
application/json- response
An error response.
error*What went wrong.
contract_mismatch: X-Marfa-Contract names another contract version than this instance speaks, or is not a whole number. Nothing was done.
application/json- response
An error response.
error*What went wrong.
rate_limited: you sent too many requests. Wait for the number of seconds in Retry-After, then try again.
application/json- response
An error response.
error*What went wrong.
internal_error: Marfa failed in a way it didn't expect, and the request may not have completed. Read what you changed before you repeat a write.
application/json- response
An error response.
error*What went wrong.
write_contention: the database was busy, and Marfa couldn't complete the request in time. Nothing changed. Try the request again. While a restore runs, details.reason is restore_running.
application/json- response
An error response.
error*What went wrong.
insufficient_storage: the disk that holds the instance's data has no room for the request, or the request would leave less free than the instance keeps in reserve. Nothing changed, unless details.write_outcome is unknown, which means the write may have landed: read what you changed before you repeat it. Free space on the disk, then try the request again.
application/json- response
An error response.
error*What went wrong.
curl -X GET 'http://localhost:8600/webhooks/string'{ "id": "01a1011f-f8a6-7d27-8213-d126f553409e", "url": "https://hooks.example.com/marfa", "events": [ "item.created", "item.updated" ], "type_filter": "acme.deal", "secret": "****deb0", "active": true, "created_at": "2026-10-03T09:56:05.889Z", "updated_at": "2026-10-03T09:56:05.889Z", "maker": { "kind": "key", "id": "01a1011b-b5e5-7be6-8f3b-77492475b5a4", "name": "CRM sync" }}