Webhook Jobs Index API

Route

POST

Purpose


Parameters


token string 100 required
Authentication token for either an application or session.
integration_id integer 100 required
The integration the webhook jobs belong to. Necessary to validate user against the scoped_integrations
count boolean 300
If passed as true, the API will return a count key which contains the full amount of results.
view string 400
The view attribute controls the params passed back in the results.
Possible values
  • planointegrate_view

search hash 500
Search parameters for filtering results
  • search.term string
    Term that is being searched against.
  • search.attributes array
    Attributes that search term is compared against.
    Possible values
    • status
    • address
    • event
    • order_id
    • webhook_subscriber
    • callback_url

filters hash 600
object of filters that can be applied to filter results.
  • filters.date_range_start string
    Date that indicates which webhook jobs were created AFTER given date time.
  • filters.date_range_end string
    Date that indicates which webhook jobs were created BEFORE given date time.
  • filters.status_code array
  • filters.event_type array
    Possible values
    • received
    • processed
    • awaiting_availability
    • awaiting_scheduling
    • window_selected
    • scheduled
    • awaiting_reschedule
    • unable_to_complete
    • post_processing
    • delivered
    • canceled
  • filters.status array
    Possible values
    • assembly
    • canceled
    • cancelled
    • committed
    • completed
    • hold
    • new_request
    • notified
    • on_site
    • ordered
    • order_processing
    • pending_appointment
    • pending_reschedule
    • post_processing
    • ready_to_schedule
    • scheduled
    • scheduling
    • submitted
    • submitted_cancel_onsite
    • unscheduled
  • filters.subscribers array
  • filters.endpoint array

page hash 700
Pagination parameters for controlling page results
  • page.size integer
    Number of items returned in paginated results.
  • page.number integer
    Page number that controls the offset of the paginated results.

sort hash 1000
Sorting parameters for controlling the order of the results
  • sort.by string
    Attribute that results are sorted by.
    Possible values
    • status_code
    • event_type
    • last_sent_at
  • sort.order string
    Controls whether the result are sorted in ascending or descending order.
    Possible values
    • asc
    • desc

Request Body Example: application/json

Responses

action-successful 200

This status indicates that the request was successful. If the request returns data, it can be found in the data key.

invalid-token 401

This status is returned when the authentication token passed is invalid.

session-expired 401

This status is returned a session is older than seven days or hasn't been used in 72 hours. The user will need to reauthenticate. We allow our users to save a remember_me preference which will make there sessions last indefinitely.

client-required 401

This status is returned when the user makeing the request doesn't have a client, employee or liaison record. This means that they don't have any roles or permissions. Because we only allow our clients to register as a client, the user should be redirected to the PlanoAuth clients registration page where they can use the `/api/v1/users/client_register` API to register as a client. Eventhough the request will not be successful, this status will still return a `session` object because a session token is needed to register as a user.

missing-param 400

This status is returned when a required param was not passed with the request.

invalid-param 400

This status is returned when a param was invalid when passed. For example, passing an id that doesn't exist or passing an invalid email address.

application-crash 500

This status is returned when there is an internal server error. Please try again later.

mandrill-email-failed 500

This status is returned when there was an issue using Mandrill to send an email. Any time this response is returned, there will be a notification in the production notifications tab so the dev team will be away of the failure. These errors will most likely correlate with a data issue and will need to be invesigated.

invalid-content-type 400

This status is returned if the request was made with the incorrect content-type so the request params could not be read. For more infromation on content-type, please refer to https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Content-Type.

route-non-existent 500

Response returned when HTTP route does not exist.

Uncommon Responses

The responses below are not very common.

no-params-decoded Uncommon

This status is returned the request body was decoded, but no params where found.

invalid-encoded-params Uncommon

This status is returned when the request body could not be decoded properly. This generally means that you are requesting a sensative_params API and your request body was not base64 encoded.

route-not-found Uncommon

This status is returned when the route record being requested hasn't been deployed yet.

identify-request-error Uncommon

This status is returned when there is an internal server error before the route could be identified. Please try again later.

service-not-found Uncommon

This status is returned when the route's API service record being requested hasn't been deployed yet.