{"_id":"56bcded4ac1c5c1900b2dbae","category":{"_id":"56b49a2a5f1cf00d00cc468e","version":"54603b69a7c6f71400a9c68d","__v":1,"pages":["56b49d81e5b9bd1700520cf9"],"project":"54603b69a7c6f71400a9c68a","sync":{"url":"","isSync":false},"reference":false,"createdAt":"2016-02-05T12:48:42.338Z","from_sync":false,"order":2,"slug":"webhooks","title":"Webhooks"},"user":"54603b58a7c6f71400a9c689","__v":4,"editedParams":true,"editedParams2":true,"project":"54603b69a7c6f71400a9c68a","parentDoc":null,"version":{"_id":"54603b69a7c6f71400a9c68d","__v":13,"project":"54603b69a7c6f71400a9c68a","createdAt":"2014-11-10T04:13:29.941Z","releaseDate":"2014-11-10T04:13:29.941Z","categories":["54603b6aa7c6f71400a9c68e","56b49a2a5f1cf00d00cc468e","56b49a327761871700654a11","56b4a424eed075230097d670","56b4a4d399c8d30d00f557cc","56bcb522fb9be80d00328055","57078fb149ca950e00c8c871","576bdbe6de333e0e00d0aada","576c36b46c24681700c90304","592d8a2db29dc20f00aab31d","5964c973ce3e85001b66868d","5964cd6769ec8d0083a28922","5978a3f4da9d5e001a948a00"],"is_deprecated":false,"is_hidden":false,"is_beta":true,"is_stable":true,"codename":"","version_clean":"1.0.0","version":"1"},"updates":["56d4cd7873dcd20b00fb872c","584ac0d696f59f0f00615749","5894b2544d9c7e27002e423d"],"next":{"pages":[],"description":""},"createdAt":"2016-02-11T19:19:48.867Z","link_external":false,"link_url":"","githubsync":"","sync_unique":"","hidden":false,"api":{"results":{"codes":[{"code":"[\n  {\n    \"event_type\":{\n      \"kind\":\"1-on-1\",\n      \"slug\":\"event_type_name\",\n      \"name\":\"Event Type Name\",\n      \"duration\":15\n    },\n    \"event\":{\n      \"uuid\":\"BBBBBBBBBBBBBBBB\",\n      \"assigned_to\": [\n\t\t\t\t\"Jane Sample Data\"\n\t\t\t],\n      \"start_time\":\"2016-02-05T12:00:00Z\",\n      \"end_time\":\"2016-02-05T12:15:00Z\",\n      \"created_at\":\"2016-02-05T00:00:00Z\",\n      \"canceled\":false,\n      \"canceler_name\":null,\n      \"cancel_reason\":null,\n      \"canceled_at\":null\n    },\n    \"invitee\":{\n      \"uuid\":\"AAAAAAAAAAAAAAAA\",\n      \"name\":\"Joe Sample Data\",\n      \"email\":\"not.a.real.email:::at:::example.com\",\n      \"timezone\":\"UTC\",\n      \"created_at\":\"2016-02-05T00:00:00Z\",\n      \"canceled\":false,\n      \"canceler_name\":null,\n      \"cancel_reason\":null,\n      \"canceled_at\":null\n    },\n    \"questionnaire\":[\n      {\n        \"question\":\"Skype ID\",\n        \"answer\":\"fake_skype_id\"\n      },\n      {\n        \"question\":\"Facebook ID\",\n        \"answer\":\"fake_facebook_id\"\n      }\n    ],\n    \"tracking\":{\n      \"utm_campaign\":null,\n      \"utm_source\":null,\n      \"utm_medium\":null,\n      \"utm_content\":null,\n      \"utm_term\":null\n    }\n  }\n]","name":"Active Invitee","status":200,"language":"json"},{"status":200,"language":"json","code":"[\n  {\n    \"event_type\":{\n      \"kind\":\"1-on-1\",\n      \"slug\":\"event_type_name\",\n      \"name\":\"Event Type Name\",\n      \"duration\":15\n    },\n    \"event\":{\n      \"uuid\":\"BBBBBBBBBBBBBBBB\",\n      \"assigned_to\": [\n\t\t\t\t\"Jane Sample Data\"\n\t\t\t],\n      \"start_time\":\"2016-02-05T12:00:00Z\",\n      \"end_time\":\"2016-02-05T12:15:00Z\",\n      \"created_at\":\"2016-02-05T00:00:00Z\",\n      \"canceled\":true,\n      \"canceler_name\":\"Joe Sample Data\",\n      \"cancel_reason\":\"This was not a real meeting.\",\n      \"canceled_at\":\"2016-02-05T00:00:00Z\"\n    },\n    \"invitee\":{\n      \"uuid\":\"AAAAAAAAAAAAAAAA\",\n      \"name\":\"Joe Sample Data\",\n      \"email\":\"not.a.real.email@example.com\",\n      \"timezone\":\"UTC\",\n      \"created_at\":\"2016-02-05T00:00:00Z\",\n      \"canceled\":true,\n      \"canceler_name\":\"Joe Sample Data\",\n      \"cancel_reason\":\"This was not a real meeting.\",\n      \"canceled_at\":\"2016-02-05T00:00:00Z\"\n    },\n    \"questions_and_answers\":[\n      {\n        \"question\":\"Skype ID\",\n        \"answer\":\"fake_skype_id\"\n      },\n      {\n        \"question\":\"Facebook ID\",\n        \"answer\":\"fake_facebook_id\"\n      }\n    ],\n    \"tracking\":{\n      \"utm_campaign\":null,\n      \"utm_source\":null,\n      \"utm_medium\":null,\n      \"utm_content\":null,\n      \"utm_term\":null\n    }\n  }\n]","name":"Canceled Invitee"}]},"settings":"","examples":{"codes":[{"code":"curl https://calendly.com/api/v1/invitees/samples\n","language":"curl","name":"Active Invitee"},{"name":"Canceled Invitee","code":"curl https://calendly.com/api/v1/invitees/samples?canceled=true","language":"curl"}]},"auth":"optional","params":[{"_id":"56b49c5f3d5f130d00dad104","ref":"","in":"body","required":false,"desc":"Optional - set to 'true' to see canceled invitee samples","default":"","type":"string","name":"canceled"}],"url":"/invitees/samples"},"isReference":false,"order":4,"body":"When you subscribe to a Webhook Subscription.  We will send POST requests to the URL you provided.\n[block:api-header]\n{\n  \"type\": \"basic\",\n  \"title\": \"Example Notification\"\n}\n[/block]\n## HEADERS\n\n```\nContent-Type: application/json\nUser-Agent: Calendly\nAccept-Encoding: gzip\nX-Calendly-Hook-Id: 12345\n```\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"{\\n  \\\"event\\\":\\\"invitee.created\\\",\\n  \\\"time\\\":\\\"2016-08-23T19:16:01Z\\\",\\n  \\\"payload\\\":{\\n    \\\"event_type\\\":{\\n      \\\"kind\\\":\\\"1-on-1\\\",\\n      \\\"slug\\\":\\\"event_type_name\\\",\\n      \\\"name\\\":\\\"Event Type Name\\\",\\n      \\\"duration\\\":15\\n    },\\n    \\\"event\\\":{\\n      \\\"uuid\\\":\\\"BBBBBBBBBBBBBBBB\\\",\\n      \\\"assigned_to\\\":[\\n        \\\"Jane Sample Data\\\"\\n      ],\\n      \\\"extended_assigned_to\\\": [\\n        {\\n        \\t\\\"name\\\": \\\"Jane Sample Data\\\",\\n        \\t\\\"email\\\": \\\"user@example.com\\\",\\n        \\t\\\"primary\\\": false\\n        }\\n      ],\\n      \\\"start_time\\\":\\\"2016-08-23T12:00:00Z\\\",\\n      \\\"start_time_pretty\\\":\\\"12:00pm - Tuesday, August 23, 2016\\\",\\n      \\\"invitee_start_time\\\":\\\"2016-08-23T12:00:00Z\\\",\\n      \\\"invitee_start_time_pretty\\\":\\\"12:00pm - Tuesday, August 23, 2016\\\",\\n      \\\"end_time\\\":\\\"2016-08-23T12:15:00Z\\\",\\n      \\\"end_time_pretty\\\":\\\"12:15pm - Tuesday, August 23, 2016\\\",\\n      \\\"invitee_end_time\\\":\\\"2016-08-23T12:15:00Z\\\",\\n      \\\"invitee_end_time_pretty\\\":\\\"12:15pm - Tuesday, August 23, 2016\\\",\\n      \\\"created_at\\\":\\\"2016-08-23T00:00:00Z\\\",\\n      \\\"location\\\":\\\"The Coffee Shop\\\",\\n      \\\"canceled\\\":false,\\n      \\\"canceler_name\\\":null,\\n      \\\"cancel_reason\\\":null,\\n      \\\"canceled_at\\\":null\\n    },\\n    \\\"invitee\\\":{\\n      \\\"uuid\\\":\\\"AAAAAAAAAAAAAAAA\\\",\\n      \\\"first_name\\\":\\\"Joe\\\",\\n      \\\"last_name\\\":\\\"Sample Data\\\",\\n      \\\"name\\\":\\\"Joe Sample Data\\\",\\n      \\\"email\\\":\\\"not.a.real.email@example.com\\\",\\n      \\\"timezone\\\":\\\"UTC\\\",\\n      \\\"created_at\\\":\\\"2016-08-23T00:00:00Z\\\",\\n      \\\"is_reschedule\\\":false,\\n      \\\"canceled\\\":false,\\n      \\\"canceler_name\\\":null,\\n      \\\"cancel_reason\\\":null,\\n      \\\"canceled_at\\\":null\\n    },\\n    \\\"questions_and_answers\\\":[\\n      {\\n        \\\"question\\\":\\\"Skype ID\\\",\\n        \\\"answer\\\":\\\"fake_skype_id\\\"\\n      },\\n      {\\n        \\\"question\\\":\\\"Facebook ID\\\",\\n        \\\"answer\\\":\\\"fake_facebook_id\\\"\\n      },\\n      {\\n        \\\"question\\\":\\\"Twitter ID\\\",\\n        \\\"answer\\\":\\\"fake_twitter_id\\\"\\n      },\\n      {\\n        \\\"question\\\":\\\"Google ID\\\",\\n        \\\"answer\\\":\\\"fake_google_id\\\"\\n      }\\n    ],\\n    \\\"questions_and_responses\\\":{\\n      \\\"1_question\\\":\\\"Skype ID\\\",\\n      \\\"1_response\\\":\\\"fake_skype_id\\\",\\n      \\\"2_question\\\":\\\"Facebook ID\\\",\\n      \\\"2_response\\\":\\\"fake_facebook_id\\\",\\n      \\\"3_question\\\":\\\"Twitter ID\\\",\\n      \\\"3_response\\\":\\\"fake_twitter_id\\\",\\n      \\\"4_question\\\":\\\"Google ID\\\",\\n      \\\"4_response\\\":\\\"fake_google_id\\\"\\n    },\\n    \\\"tracking\\\":{\\n      \\\"utm_campaign\\\":null,\\n      \\\"utm_source\\\":null,\\n      \\\"utm_medium\\\":null,\\n      \\\"utm_content\\\":null,\\n      \\\"utm_term\\\":null,\\n      \\\"salesforce_uuid\\\":null\\n    },\\n    \\\"old_event\\\":null,\\n    \\\"old_invitee\\\":null,\\n    \\\"new_event\\\":null,\\n    \\\"new_invitee\\\":null\\n  }\\n}\",\n      \"language\": \"json\",\n      \"name\": \"Invitee Created\"\n    },\n    {\n      \"code\": \"{\\n  \\\"event\\\":\\\"invitee.canceled\\\",\\n  \\\"time\\\":\\\"2016-08-23T19:16:01Z\\\",\\n  \\\"payload\\\":{\\n    \\\"event_type\\\":{\\n      \\\"kind\\\":\\\"1-on-1\\\",\\n      \\\"slug\\\":\\\"event_type_name\\\",\\n      \\\"name\\\":\\\"Event Type Name\\\",\\n      \\\"duration\\\":15\\n    },\\n    \\\"event\\\":{\\n      \\\"uuid\\\":\\\"BBBBBBBBBBBBBBBB\\\",\\n      \\\"assigned_to\\\":[\\n        \\\"Jane Sample Data\\\"\\n      ],\\n      \\\"extended_assigned_to\\\": [\\n        {\\n          \\\"name\\\": \\\"Jane Sample Data\\\",\\n          \\\"email\\\": \\\"user@example.com\\\",\\n          \\\"primary\\\": false\\n        }\\n      ],\\n      \\\"start_time\\\":\\\"2016-08-26T12:00:00Z\\\",\\n      \\\"start_time_pretty\\\":\\\"12:00pm - Friday, August 26, 2016\\\",\\n      \\\"invitee_start_time\\\":\\\"2016-08-26T12:00:00Z\\\",\\n      \\\"invitee_start_time_pretty\\\":\\\"12:00pm - Friday, August 26, 2016\\\",\\n      \\\"end_time\\\":\\\"2016-08-26T12:15:00Z\\\",\\n      \\\"end_time_pretty\\\":\\\"12:15pm - Friday, August 26, 2016\\\",\\n      \\\"invitee_end_time\\\":\\\"2016-08-26T12:15:00Z\\\",\\n      \\\"invitee_end_time_pretty\\\":\\\"12:15pm - Friday, August 26, 2016\\\",\\n      \\\"created_at\\\":\\\"2016-08-26T00:00:00Z\\\",\\n      \\\"location\\\":\\\"The Coffee Shop\\\",\\n      \\\"canceled\\\":true,\\n      \\\"canceler_name\\\":\\\"Joe Sample Data\\\",\\n      \\\"cancel_reason\\\":\\\"This was not a real meeting.\\\",\\n      \\\"canceled_at\\\":\\\"2016-08-26T00:00:00Z\\\"\\n    },\\n    \\\"invitee\\\":{\\n      \\\"uuid\\\":\\\"AAAAAAAAAAAAAAAA\\\",\\n      \\\"first_name\\\":\\\"Joe\\\",\\n      \\\"last_name\\\":\\\"Sample Data\\\",\\n      \\\"name\\\":\\\"Joe Sample Data\\\",\\n      \\\"email\\\":\\\"not.a.real.email@example.com\\\",\\n      \\\"timezone\\\":\\\"UTC\\\",\\n      \\\"created_at\\\":\\\"2016-08-26T00:00:00Z\\\",\\n      \\\"is_reschedule\\\":false,\\n      \\\"canceled\\\":true,\\n      \\\"canceler_name\\\":\\\"Joe Sample Data\\\",\\n      \\\"cancel_reason\\\":\\\"This was not a real meeting.\\\",\\n      \\\"canceled_at\\\":\\\"2016-08-26T00:00:00Z\\\"\\n    },\\n    \\\"questions_and_answers\\\":[\\n      {\\n        \\\"question\\\":\\\"Skype ID\\\",\\n        \\\"answer\\\":\\\"fake_skype_id\\\"\\n      },\\n      {\\n        \\\"question\\\":\\\"Facebook ID\\\",\\n        \\\"answer\\\":\\\"fake_facebook_id\\\"\\n      },\\n      {\\n        \\\"question\\\":\\\"Twitter ID\\\",\\n        \\\"answer\\\":\\\"fake_twitter_id\\\"\\n      },\\n      {\\n        \\\"question\\\":\\\"Google ID\\\",\\n        \\\"answer\\\":\\\"fake_google_id\\\"\\n      }\\n    ],\\n    \\\"questions_and_responses\\\":{\\n      \\\"1_question\\\":\\\"Skype ID\\\",\\n      \\\"1_response\\\":\\\"fake_skype_id\\\",\\n      \\\"2_question\\\":\\\"Facebook ID\\\",\\n      \\\"2_response\\\":\\\"fake_facebook_id\\\",\\n      \\\"3_question\\\":\\\"Twitter ID\\\",\\n      \\\"3_response\\\":\\\"fake_twitter_id\\\",\\n      \\\"4_question\\\":\\\"Google ID\\\",\\n      \\\"4_response\\\":\\\"fake_google_id\\\"\\n    },\\n    \\\"tracking\\\":{\\n      \\\"utm_campaign\\\":null,\\n      \\\"utm_source\\\":null,\\n      \\\"utm_medium\\\":null,\\n      \\\"utm_content\\\":null,\\n      \\\"utm_term\\\":null,\\n      \\\"salesforce_uuid\\\":null\\n    },\\n    \\\"old_event\\\":null,\\n    \\\"old_invitee\\\":null,\\n    \\\"new_event\\\":null,\\n    \\\"new_invitee\\\":null\\n  }\\n}\",\n      \"language\": \"json\",\n      \"name\": \"Invitee Canceled\"\n    }\n  ]\n}\n[/block]","excerpt":"","slug":"sample-webhook-data","type":"basic","title":"Sample Webhook Data"}

Sample Webhook Data


When you subscribe to a Webhook Subscription. We will send POST requests to the URL you provided. [block:api-header] { "type": "basic", "title": "Example Notification" } [/block] ## HEADERS ``` Content-Type: application/json User-Agent: Calendly Accept-Encoding: gzip X-Calendly-Hook-Id: 12345 ``` [block:code] { "codes": [ { "code": "{\n \"event\":\"invitee.created\",\n \"time\":\"2016-08-23T19:16:01Z\",\n \"payload\":{\n \"event_type\":{\n \"kind\":\"1-on-1\",\n \"slug\":\"event_type_name\",\n \"name\":\"Event Type Name\",\n \"duration\":15\n },\n \"event\":{\n \"uuid\":\"BBBBBBBBBBBBBBBB\",\n \"assigned_to\":[\n \"Jane Sample Data\"\n ],\n \"extended_assigned_to\": [\n {\n \t\"name\": \"Jane Sample Data\",\n \t\"email\": \"user@example.com\",\n \t\"primary\": false\n }\n ],\n \"start_time\":\"2016-08-23T12:00:00Z\",\n \"start_time_pretty\":\"12:00pm - Tuesday, August 23, 2016\",\n \"invitee_start_time\":\"2016-08-23T12:00:00Z\",\n \"invitee_start_time_pretty\":\"12:00pm - Tuesday, August 23, 2016\",\n \"end_time\":\"2016-08-23T12:15:00Z\",\n \"end_time_pretty\":\"12:15pm - Tuesday, August 23, 2016\",\n \"invitee_end_time\":\"2016-08-23T12:15:00Z\",\n \"invitee_end_time_pretty\":\"12:15pm - Tuesday, August 23, 2016\",\n \"created_at\":\"2016-08-23T00:00:00Z\",\n \"location\":\"The Coffee Shop\",\n \"canceled\":false,\n \"canceler_name\":null,\n \"cancel_reason\":null,\n \"canceled_at\":null\n },\n \"invitee\":{\n \"uuid\":\"AAAAAAAAAAAAAAAA\",\n \"first_name\":\"Joe\",\n \"last_name\":\"Sample Data\",\n \"name\":\"Joe Sample Data\",\n \"email\":\"not.a.real.email@example.com\",\n \"timezone\":\"UTC\",\n \"created_at\":\"2016-08-23T00:00:00Z\",\n \"is_reschedule\":false,\n \"canceled\":false,\n \"canceler_name\":null,\n \"cancel_reason\":null,\n \"canceled_at\":null\n },\n \"questions_and_answers\":[\n {\n \"question\":\"Skype ID\",\n \"answer\":\"fake_skype_id\"\n },\n {\n \"question\":\"Facebook ID\",\n \"answer\":\"fake_facebook_id\"\n },\n {\n \"question\":\"Twitter ID\",\n \"answer\":\"fake_twitter_id\"\n },\n {\n \"question\":\"Google ID\",\n \"answer\":\"fake_google_id\"\n }\n ],\n \"questions_and_responses\":{\n \"1_question\":\"Skype ID\",\n \"1_response\":\"fake_skype_id\",\n \"2_question\":\"Facebook ID\",\n \"2_response\":\"fake_facebook_id\",\n \"3_question\":\"Twitter ID\",\n \"3_response\":\"fake_twitter_id\",\n \"4_question\":\"Google ID\",\n \"4_response\":\"fake_google_id\"\n },\n \"tracking\":{\n \"utm_campaign\":null,\n \"utm_source\":null,\n \"utm_medium\":null,\n \"utm_content\":null,\n \"utm_term\":null,\n \"salesforce_uuid\":null\n },\n \"old_event\":null,\n \"old_invitee\":null,\n \"new_event\":null,\n \"new_invitee\":null\n }\n}", "language": "json", "name": "Invitee Created" }, { "code": "{\n \"event\":\"invitee.canceled\",\n \"time\":\"2016-08-23T19:16:01Z\",\n \"payload\":{\n \"event_type\":{\n \"kind\":\"1-on-1\",\n \"slug\":\"event_type_name\",\n \"name\":\"Event Type Name\",\n \"duration\":15\n },\n \"event\":{\n \"uuid\":\"BBBBBBBBBBBBBBBB\",\n \"assigned_to\":[\n \"Jane Sample Data\"\n ],\n \"extended_assigned_to\": [\n {\n \"name\": \"Jane Sample Data\",\n \"email\": \"user@example.com\",\n \"primary\": false\n }\n ],\n \"start_time\":\"2016-08-26T12:00:00Z\",\n \"start_time_pretty\":\"12:00pm - Friday, August 26, 2016\",\n \"invitee_start_time\":\"2016-08-26T12:00:00Z\",\n \"invitee_start_time_pretty\":\"12:00pm - Friday, August 26, 2016\",\n \"end_time\":\"2016-08-26T12:15:00Z\",\n \"end_time_pretty\":\"12:15pm - Friday, August 26, 2016\",\n \"invitee_end_time\":\"2016-08-26T12:15:00Z\",\n \"invitee_end_time_pretty\":\"12:15pm - Friday, August 26, 2016\",\n \"created_at\":\"2016-08-26T00:00:00Z\",\n \"location\":\"The Coffee Shop\",\n \"canceled\":true,\n \"canceler_name\":\"Joe Sample Data\",\n \"cancel_reason\":\"This was not a real meeting.\",\n \"canceled_at\":\"2016-08-26T00:00:00Z\"\n },\n \"invitee\":{\n \"uuid\":\"AAAAAAAAAAAAAAAA\",\n \"first_name\":\"Joe\",\n \"last_name\":\"Sample Data\",\n \"name\":\"Joe Sample Data\",\n \"email\":\"not.a.real.email@example.com\",\n \"timezone\":\"UTC\",\n \"created_at\":\"2016-08-26T00:00:00Z\",\n \"is_reschedule\":false,\n \"canceled\":true,\n \"canceler_name\":\"Joe Sample Data\",\n \"cancel_reason\":\"This was not a real meeting.\",\n \"canceled_at\":\"2016-08-26T00:00:00Z\"\n },\n \"questions_and_answers\":[\n {\n \"question\":\"Skype ID\",\n \"answer\":\"fake_skype_id\"\n },\n {\n \"question\":\"Facebook ID\",\n \"answer\":\"fake_facebook_id\"\n },\n {\n \"question\":\"Twitter ID\",\n \"answer\":\"fake_twitter_id\"\n },\n {\n \"question\":\"Google ID\",\n \"answer\":\"fake_google_id\"\n }\n ],\n \"questions_and_responses\":{\n \"1_question\":\"Skype ID\",\n \"1_response\":\"fake_skype_id\",\n \"2_question\":\"Facebook ID\",\n \"2_response\":\"fake_facebook_id\",\n \"3_question\":\"Twitter ID\",\n \"3_response\":\"fake_twitter_id\",\n \"4_question\":\"Google ID\",\n \"4_response\":\"fake_google_id\"\n },\n \"tracking\":{\n \"utm_campaign\":null,\n \"utm_source\":null,\n \"utm_medium\":null,\n \"utm_content\":null,\n \"utm_term\":null,\n \"salesforce_uuid\":null\n },\n \"old_event\":null,\n \"old_invitee\":null,\n \"new_event\":null,\n \"new_invitee\":null\n }\n}", "language": "json", "name": "Invitee Canceled" } ] } [/block]