Webhooks

Recibe los eventos de Marsial en tu endpoint HTTPS.

Ver el endpoint de webhooks

GET/v1/webhook-endpoint

Respuesta 200

data

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

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

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

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"]

Configurar el endpoint de webhooks

PUT/v1/webhook-endpoint

Sin events recibes todos. El secreto de firma solo se devuelve la primera vez.

Cuerpo

urlstring (starts_with)obligatorio
eventsstring[]

Respuesta 200

data

endpointobjectobligatorio
endpoint
- urlstring (uri)obligatorio
- eventsstring[]obligatorio
- createdAtstring (date-time)obligatorio
- updatedAtstring (date-time)obligatorio
secretstring
Secreto de firma; solo se devuelve al crear el endpoint.

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"
  }'

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();

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"]

Borrar el endpoint de webhooks

DELETE/v1/webhook-endpoint

Respuesta 204

Sin contenido

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

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

import os, requests

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

Enviar un evento de prueba

POST/v1/webhook-endpoint/test

Envía al endpoint un ejemplo del evento con test: true e ids inventados, firmado y con reintentos como uno real. El endpoint tiene que estar suscrito a él.

Cuerpo

typestringobligatorio
El evento del que enviar un ejemplo.

Respuesta 202

data

idstringobligatorio
El evt_… del ejemplo.
typestringobligatorio

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

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();

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"]