Matchai Docs

Retry a deliveryComing soon

Sends the event of a failed delivery again, now.

Coming soon. This is documented ahead of launch so you can plan your integration; it is not available yet.
POST
/webhook-subscriptions/{webhook_subscription_id}/deliveries/{delivery_id}/retry

Coming soon. Sends the event of a failed delivery again, now.

Scopes: webhooks:manage

Pricing: Included with the connection.

Authorization

headerAuthorizationBearer <matchai_<base62>>

A personal API key, sent as Authorization: Bearer matchai_…. Create keys in Matchai under Settings → Connectors → Advanced (for developers). A key starts with matchai_ followed by letters and digits, carries the scopes chosen when it was created, and can be revoked at any time. Keys reach only the account that created them: to serve other professionals, use Connect with Matchai.

Scope: webhooks:manage

Path Parameters

webhook_subscription_id*string

Webhook subscription id.

Length1 <= length <= 64
delivery_id*string

Delivery id.

Length1 <= length <= 64

Header Parameters

Idempotency-Key?string

A unique string (a UUID works). Retrying with the same key within 24 hours returns the first response instead of acting twice. Reusing a key with a different body returns 409 idempotency_key_reused.

Length1 <= length <= 255

Response Body

The new delivery.

application/json
  1. response
id*string

Delivery id.

Length1 <= length <= 64
event_id*string

Event id.

Length1 <= length <= 64
event_type*EventType

New event types may be added. Ignore types you do not know.

Value in"lead.created""contact.created""contact.updated""contact.converted""contact.deleted""conversation.created""message.received""message.sent""appointment.requested""appointment.booked""appointment.rescheduled""appointment.cancelled""listing.created""listing.updated""listing.published""listing.unpublished""listing.archived""listing.deleted""listing.saved""listing.generation.completed""document.created""drop_link.upload_received""invitation.accepted""notification.created""approval.resolved""webhook.test"
attempt*integer

Attempt number, from 1.

Range1 <= value
status*string
Value in"pending""succeeded""failed"
response_status?|

HTTP status your endpoint returned.

error?|

Why it failed, for example "timeout after 10 s".

created_at*string

Attempted.

Formatdate-time
next_attempt_at?|

Next retry.

Formatdate-time
Example Request
curl -X POST 'https://api.matchai.co/v1/webhook-subscriptions/string/deliveries/string/retry' \  -H 'Idempotency-Key: 6f1d3c2a-0b7e-4f5a-9c8d-1e2f3a4b5c6d'
Example Response
{  "id": "string",  "event_id": "string",  "event_type": "lead.created",  "attempt": 1,  "status": "pending",  "response_status": 0,  "error": "string",  "created_at": "2019-08-24T14:15:22Z",  "next_attempt_at": "2019-08-24T14:15:22Z"}