Inbound webhooks

Create an inbound endpoint

Creates an inbound endpoint for the connector and returns it. Save its path: this is the only response that shows it in full.

POST
/connectors/{id}/endpoints

Authorization

bearerAuth
headerAuthorizationBearer <token>

Authenticate with an API key (marfa_k1_…) or an OAuth access token (marfa_at_…).

Path parameters

id*string

The ID of the connector.

Header parameters

X-Marfa-Instance-Id?string

The ID of the instance you expect, as GET / returns it. If another instance answers at this address, Marfa returns 409 instance_changed and doesn't write. Leave it out to send the request to whichever instance answers.

Match^[0-9a-f]{8}-[0-9a-f]{4}-7[0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$

Request body

application/json
  1. body
label?string

A name for people to read. Leave it out for none.

Length1 <= length <= 200
duplicate_header?string

A header whose value identifies a delivery, such as X-GitHub-Delivery. Marfa stores a delivery that repeats a value and marks it as a repeat. Leave it out to mark none.

Match^[!#$%&'*+.^_`|~0-9A-Za-z-]{1,100}$

Response body

About errors

Returns the endpoint, with its full path.

application/json
  1. response

An inbound endpoint is an address where a sender posts to a connector without a credential: the address is the credential.

id*string

Unique identifier for the inbound endpoint.

connector_id*string

The ID of the current connector registration for the endpoint's source.

label*|

A name for people to read; null if none was given.

duplicate_header*|

The header whose value identifies a delivery, lowercased; null if none was set. A delivery that repeats a value is marked as a repeat in duplicate_of.

path*string

The address a sender posts to, a path on this instance. It is in full only in the response that created the endpoint; after that it shows /inbound/**** and its last four characters.

created_at*string

When the endpoint was created.

retired_at*|

When the endpoint was retired; null while it is live.

  • validation_error: label isn't 1 to 200 characters, duplicate_header isn't a valid header name, or the body has a top-level field this endpoint doesn't take.
application/json
  1. 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
  1. response

An error response.

error*

What went wrong.

  • forbidden: your credential is neither the connector's own key nor a holder of connectors.manage.
application/json
  1. response

An error response.

error*

What went wrong.

  • connector_not_found: no connector has this ID.
application/json
  1. response

An error response.

error*

What went wrong.

request_timeout: the request body didn't arrive whole within 180 seconds. Nothing changed, and Marfa closed the connection. Send the request again. A body larger than about 21 MiB can't arrive in that time over a 1 Mbit/s link, so send it in smaller requests.

application/json
  1. response

An error response.

error*

What went wrong.

  • conflict: the connector already has 10 live endpoints (retire one first), or its key is revoked or past its expires_at, so an address would never answer.
application/json
  1. 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
  1. response

An error response.

error*

What went wrong.

request_too_large: the request body is larger than this instance accepts.

application/json
  1. 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
  1. 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
  1. 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
  1. 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
  1. response

An error response.

error*

What went wrong.

curl -X POST 'http://localhost:8600/connectors/string/endpoints' \  -H 'Content-Type: application/json' \  -d '{}'
About errors
{  "id": "01a10124-b120-765c-9e33-12865174c46b",  "connector_id": "01a10123-4825-7ff1-8fde-fb30a676e02b",  "label": "Invoice events",  "duplicate_header": null,  "path": "/inbound/2VQuysmm0VKcNeX8g6vthEB9_bz0HOp863HlkanYd2o",  "created_at": "2026-10-03T10:07:20.026Z",  "retired_at": null}