WaitForItWaitForIt
WaitForIt

​Webhooks

Endpoint:https://api.waitforit.me/v1

​Get all webhooks

GET
https://api.waitforit.me/v1
/webhook

Retrieve the list of created webhooks. Requires the webhook:view role on the API key.

​Get all webhooks › Responses

    • webhook_idstring · uuid · readOnly · required

      The id of the webhook.

    • namestring · required

      The name of the webhook.

    • urlstring ·  · required

      The endpoint that you want us to send events to.

    • activeboolean · required

      This value controls whether the webhook will have events sent to it, or not.

    • eventsstring[] · minItems: 1 · unique · required

      The list of events you want us to send to your endpoint.

      Enum values:
      NewSignup
      NewReferral
    • filterobject

      Filter events by certain criteria.

​Create new webhook

POST
https://api.waitforit.me/v1
/webhook

Create a webhook to recieve certain events from us. For a comprehensive list of possible events that you could subscribe to see event types. Requires the webhook:create role on the API key.

​Create new webhook › Request Body

  • namestring · required

    The name of the webhook.

  • urlstring ·  · required

    The endpoint that you want us to send events to.

  • eventsstring[] · minItems: 1 · unique · required

    The list of events you want us to send to your endpoint.

    Enum values:
    NewSignup
    NewReferral
  • activeboolean

    This value controls whether the webhook will have events sent to it, or not.

  • filterobject

    Filter events by certain criteria.

​Create new webhook › Responses

    • webhook_idstring · uuid · readOnly · required

      The id of the webhook.

    • namestring · required

      The name of the webhook.

    • urlstring ·  · required

      The endpoint that you want us to send events to.

    • activeboolean · required

      This value controls whether the webhook will have events sent to it, or not.

    • eventsstring[] · minItems: 1 · unique · required

      The list of events you want us to send to your endpoint.

      Enum values:
      NewSignup
      NewReferral
    • filterobject

      Filter events by certain criteria.

​Get one webhook

GET
https://api.waitforit.me/v1
/webhook/{id}

Get all of the details of a certain webhook, including name, url, if it's active, and the events it is subscribed to. Requires the webhook:view role on the API key.

​Get one webhook › path Parameters

  • idstring · uuid · required

    The id of the webhook.

​Get one webhook › Responses

    • webhook_idstring · uuid · readOnly · required

      The id of the webhook.

    • namestring · required

      The name of the webhook.

    • urlstring ·  · required

      The endpoint that you want us to send events to.

    • activeboolean · required

      This value controls whether the webhook will have events sent to it, or not.

    • eventsstring[] · minItems: 1 · unique · required

      The list of events you want us to send to your endpoint.

      Enum values:
      NewSignup
      NewReferral
    • filterobject

      Filter events by certain criteria.

​Update a webhook

PUT
https://api.waitforit.me/v1
/webhook/{id}

Update the webhook by putting any of the changed values. They will update the webhook to the new values and keep the rest the same. Requires the webhook:update role on the API key.

​Update a webhook › path Parameters

  • idstring · uuid · required

    The id of the webhook.

​Update a webhook › Request Body

  • namestring

    The name of the webhook.

  • urlstring · 

    The endpoint that you want us to send events to.

  • activeboolean

    This value controls whether the webhook will have events sent to it, or not.

  • eventsstring[] · minItems: 1 · unique

    The list of events you want us to send to your endpoint.

    Enum values:
    NewSignup
    NewReferral
  • filterobject

    Filter events by certain criteria.

​Update a webhook › Responses

    • webhook_idstring · uuid · readOnly · required

      The id of the webhook.

    • namestring · required

      The name of the webhook.

    • urlstring ·  · required

      The endpoint that you want us to send events to.

    • activeboolean · required

      This value controls whether the webhook will have events sent to it, or not.

    • eventsstring[] · minItems: 1 · unique · required

      The list of events you want us to send to your endpoint.

      Enum values:
      NewSignup
      NewReferral
    • filterobject

      Filter events by certain criteria.

​Delete a webhook

DELETE
https://api.waitforit.me/v1
/webhook/{id}

Deletes the webhook and all of it's associated data. Requires the webhook:delete role on the API key.

​Delete a webhook › path Parameters

  • idstring · uuid · required

    The id of the webhook.

​Delete a webhook › Responses

WaitlistOther endpoints