Webhooks

Receive Marsial events at your HTTPS endpoint.

Get the webhook endpoint

GET/v1/webhook-endpoint

Response 200

data

• urlstring (uri)required
• eventsstring[]required
• createdAtstring (date-time)required
• updatedAtstring (date-time)required

curl

curl "https://api.marsial.dev/v1/webhook-endpoint" \
  -H "Authorization: Bearer $MARSIAL_API_KEY"

Node

const res = await fetch('https://api.marsial.dev/v1/webhook-endpoint', {
  headers: {
    Authorization: `Bearer ${process.env.MARSIAL_API_KEY}`,
  },
});
const { data } = await res.json();

Python

import os, requests

res = requests.get(
    "https://api.marsial.dev/v1/webhook-endpoint",
    headers={"Authorization": f"Bearer {os.environ['MARSIAL_API_KEY']}"},
)
data = res.json()["data"]

Set the webhook endpoint

PUT/v1/webhook-endpoint

Omit events to receive all of them. The signing secret is returned only the first time.

Body

• urlstring (starts_with)required
• eventsstring[]

Response 200

data

• endpointobjectrequired
  endpoint

  • urlstring (uri)required
  • eventsstring[]required
  • createdAtstring (date-time)required
  • updatedAtstring (date-time)required
• secretstring

  Signing secret, returned only when the endpoint is created.

curl

curl -X PUT "https://api.marsial.dev/v1/webhook-endpoint" \
  -H "Authorization: Bearer $MARSIAL_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "url": "https://app.acme.com/webhooks/marsial"
  }'

Node

const res = await fetch('https://api.marsial.dev/v1/webhook-endpoint', {
  method: 'PUT',
  headers: {
    Authorization: `Bearer ${process.env.MARSIAL_API_KEY}`,
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
    "url": "https://app.acme.com/webhooks/marsial"
  }),
});
const { data } = await res.json();

Python

import os, requests

res = requests.put(
    "https://api.marsial.dev/v1/webhook-endpoint",
    headers={"Authorization": f"Bearer {os.environ['MARSIAL_API_KEY']}"},
    json={
        "url": "https://app.acme.com/webhooks/marsial"
    },
)
data = res.json()["data"]

Delete the webhook endpoint

DELETE/v1/webhook-endpoint

Response 204

No content

curl

curl -X DELETE "https://api.marsial.dev/v1/webhook-endpoint" \
  -H "Authorization: Bearer $MARSIAL_API_KEY"

Node

await fetch('https://api.marsial.dev/v1/webhook-endpoint', {
  method: 'DELETE',
  headers: {
    Authorization: `Bearer ${process.env.MARSIAL_API_KEY}`,
  },
});

Python

import os, requests

requests.delete(
    "https://api.marsial.dev/v1/webhook-endpoint",
    headers={"Authorization": f"Bearer {os.environ['MARSIAL_API_KEY']}"},
)

Send a test event

POST/v1/webhook-endpoint/test

Sends the endpoint a sample of the event with test: true and made-up ids, signed and retried like a real one. The endpoint must be subscribed to it.

Body

• typestringrequired

  The event to send a sample of.

Response 202

data

• idstringrequired

  evt_… of the sample.

• typestringrequired

curl

curl -X POST "https://api.marsial.dev/v1/webhook-endpoint/test" \
  -H "Authorization: Bearer $MARSIAL_API_KEY"

Node

const res = await fetch('https://api.marsial.dev/v1/webhook-endpoint/test', {
  method: 'POST',
  headers: {
    Authorization: `Bearer ${process.env.MARSIAL_API_KEY}`,
  },
});
const { data } = await res.json();

Python

import os, requests

res = requests.post(
    "https://api.marsial.dev/v1/webhook-endpoint/test",
    headers={"Authorization": f"Bearer {os.environ['MARSIAL_API_KEY']}"},
)
data = res.json()["data"]