webhooks

Create Webhook

post/api/v1/webhooks

Request

  • Base URL
    https://api.maritime.sh (the document declares no server; this is the origin it was published from)
  • URL
    https://api.maritime.sh/api/v1/webhooks
  • Auth
    HTTP bearer

Request body

urlstring required

HTTPS endpoint that will receive POSTed events (public hosts only)

eventsstring[]

Events to receive (subset of ['agent.deployed', 'agent.error', 'agent.restarted', 'agent.sleeping', 'agent.stopped', 'agent.woken', 'exec.finished', 'message.failed', 'message.reply']). Empty = all.

Response

Successful Response

idstring required
urlstring required
eventsstring[] required
isActiveboolean required
lastDeliveredAtstring date-time nullable required
lastStatusCodeinteger nullable required
consecutiveFailuresinteger required
createdAtstring date-time required
secretstring required

Signing secret, shown once. Verify X-Maritime-Signature with it.

Changes

No recorded changes to this operation across all 1 revision of this API.