Create a Webhook

POST /webhooks

Create a new webhook for your organization.

Headers

Authorization string Required

Authorize your API calls with an Arta API token

application/json

Body

webhook object Required

Additional properties are allowed.
Hide webhook attributes Show webhook attributes object
- name string
  
  The name for this Webhook.
- url string
  
  The URL for this Webhook.

Responses

201 application/json

The created webhook
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
- created_at string
- id integer(int64)
- name string
- updated_at string
- url string
400 application/json

Bad Request

POST /webhooks

curl \
 -X POST https://api.arta.io/webhooks \
 -H "Content-Type: application/json" \
 -H "Authorization: ARTA_APIKey s0e1t2e3c4a5s6t7r8o9n10o11m12y" \
 -d '{"webhook":{"name":"Production webhooks endpoint","url":"https://notifications.example.com/"}}'

Request examples

# Headers
Authorization: ARTA_APIKey s0e1t2e3c4a5s6t7r8o9n10o11m12y

# Payload
{
  "webhook": {
    "name": "Production webhooks endpoint",
    "url": "https://notifications.example.com/"
  }
}

Response examples (201)

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