POST/spaces/api/v1/webhooks.json

Creates a webhook from a user-defined URL, token and chosen events to track.

Returns a webhook response

Body Params

    • Name
      webhook
      Type
      object
      Description
      WebhookCreate represents an object to use when creating a new webhook.

    Responses

    • Code
      200
      Type
      object
      Schema
      Description
      200 OK
    • Code
      400
      Type
      object
      Schema
      Description
      400 Bad Request
    • Code
      404
      Type
      object
      Schema
      Description
      404 Not Found
    • Code
      500
      Type
      object
      Schema
      Description
      500 Internal Server Error

    Examples

    200 OK

    Webhook
    {
      "webhook": {
        "createdAt": "2024-12-05T12:30:49.490Z",
        "createdBy": {
          "id": 0,
          "meta": {},
          "type": "string"
        },
        "deletedAt": "2024-12-05T12:30:49.490Z",
        "deletedBy": {
          "id": 0,
          "meta": {},
          "type": "string"
        },
        "events": [
          {
            "id": 0,
            "meta": {},
            "type": "string"
          }
        ],
        "id": 0,
        "isActive": true,
        "latestRequest": {
          "id": 0,
          "meta": {},
          "type": "string"
        },
        "token": "string",
        "updatedAt": "2024-12-05T12:30:49.490Z",
        "updatedBy": {
          "id": 0,
          "meta": {},
          "type": "string"
        },
        "url": "string"
      }
    }