Webhooks

The Webhooks API allows you to manage webhook notifications within your Rebill account. You can retrieve, create, update and delete webhooks.

GET/v2/notifications/webhooks

Get webhooks

Retrieve all of the webhooks set in your organization.

Response

      [
        {
          "id": "0e81271a-aa3d-4493-9d46-04307e652540",
          "organizationId": "484e1976-66d8-4239-9282-8ffa000c0192",
          "parentId": "fd98078a-8768-4fdc-8e4e-ab538819e194",
          "event": "new-subscription",
          "url": "https://rebill.com/example-test-4706-a82b-e07ff8d294cf",
          "enabled": "https://rebill.com/example-test-4706-a82b-e07ff8d294cf",
          "headsUpScheduleTimeHs": 24,
          "createdAt": "2024-02-28T16:11:00.768Z",
          "updatedAt": "2024-02-28T16:11:00.768Z",
          "deletedAt": "2024-02-28T16:11:00.768Z"
        }
      ]

GET/v2/notifications/webhooks/{id}

Get webhook by id

Retrieve webhook details from its ID.

Required Path Parameters

idstringrequired

Response

  [
    {
      "id": "0e81271a-aa3d-4493-9d46-04307e652540",
      "organizationId": "484e1976-66d8-4239-9282-8ffa000c0192",
      "parentId": "fd98078a-8768-4fdc-8e4e-ab538819e194",
      "event": "new-subscription",
      "url": "https://rebill.com/example-test-4706-a82b-e07ff8d294cf",
      "enabled": "https://rebill.com/example-test-4706-a82b-e07ff8d294cf",
      "headsUpScheduleTimeHs": 24,
      "createdAt": "2024-02-28T16:11:00.768Z",
      "updatedAt": "2024-02-28T16:11:00.768Z",
      "deletedAt": "2024-02-28T16:11:00.768Z"
    }
  ]

POST/v2/notifications/webhooks

Create a webhook

Set up a new webhook. If the webhook is created for a sub-organization, it will send the notification to the parent organization.

Required Body Parameters

eventstringrequired

urlstringrequired

Optional Body Parameters

childIdstring

Response

  {
    "event": "new-subscription",
    "url": "https://rebill.com/example-test-4706-a82b-e07ff8d294cf",
    "childId": "zxcvefgh-i1j2-3k4l-5m67-n8op9q012r88"
  }

PATCH/v2/notifications/webhooks/{id}

Update a webhook

Update the properties of a specific webhook.

Required Path Parameters

idstringrequired

Required Body Parameters

urlstringrequired

Optional Body Parameters

childIdstring

Response

    {
      "event": "new-subscription",
      "url": "https://rebill.com/example-test-4706-a82b-e07ff8d294cf",
      "childId": "zxcvefgh-i1j2-3k4l-5m67-n8op9q012r88"
    }

DELETE/v2/notifications/webhooks/{id}

Delete webhook

Use this endpoint to remove webhooks from your organization.

Required Path Parameters

idstringrequired

Response

    {
      
  }