Arta API Reference

Ping a Webhook

POST /webhooks/{webhook_id}/ping

Trigger Arta to deliver a test message to an existing Webhook endpoint

Headers

Authorization string Required

Authorize your API calls with an Arta API token

Path parameters

webhook_id integer Required

webhook_id parameter

Responses

• 200 application/json

Successful Webhook response
Hide headers attributes Show headers attributes
- content-type string
- x-arta-request-id string
  
  A unique identifier for the Arta API call
Hide response attributes Show response attributes object
- id integer(int64)
- created_at string
- name string
- updated_at string
- url string
• 404 application/json

Resource Not Found
Hide headers attributes Show headers attributes
- content-type string
- x-arta-request-id string
  
  A unique identifier for the Arta API call
Hide response attribute Show response attribute object
- errors object
  
  Hide errors attribute Show errors attribute
  
  detail string

POST /webhooks/{webhook_id}/ping

curl \
 -X POST https://api.arta.io/webhooks/{webhook_id}/ping \
 -H "Authorization: ARTA_APIKey s0e1t2e3c4a5s6t7r8o9n10o11m12y"

Response examples (200)

# Headers
content-type: application/json
x-arta-request-id: FkBjuxbwLLTx4RoAARkx

# Payload
{
  "id": 4,
  "created_at": "2020-10-22T21:12:48.839165",
  "name": "Notifications Endpoint",
  "updated_at": "2020-10-22T21:12:48.839165",
  "url": "https://notifications.example.com/hooks/"
}

Response examples (404)

# Headers
content-type: application/json
x-arta-request-id: FkBjuxbwLLTx4RoAARkx

# Payload
{
  "errors": {
    "detail": "string"
  }
}